Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CLI command "metanorma release" for packaging and releasing a document #292

Open
ronaldtse opened this issue Dec 5, 2022 · 4 comments
Assignees
Labels
enhancement New feature or request

Comments

@ronaldtse
Copy link
Contributor

In ISO, there are defined "submission points" for a document to be sent to ISO/CS editors.

These are the steps that a "submission package" is necessary:

  • PWI
  • AWI
  • CD
  • DIS
  • FDIS
  • Publication

At any of these stages, a user can type "metanorma package" and then Metanorma will generate a submission package.

The submission package should contain:

  • Word output
  • PDF output
  • ISO-style NISO STS output
  • all figures named in a zip file that follows DRG directives

File names of the figures:
Screen Shot 2022-12-06 at 12 36 45 AM

Screen Shot 2022-12-06 at 12 37 01 AM

I also want to generate the "name" of the package, which can be named like this:
(ISO 34000: https://github.com/CalConnect/iso-34000)
Screen Shot 2022-12-06 at 12 37 39 AM

Where:

  • "50.00" is the harmonized stage code (HSC)
  • "20220721" is the date when the package was generated

This command can also be used by a new GitHub Action that automatically builds the package on a Git tag in a metanorma document repository. Then the user can do:

  1. Push git tag of v50.00.20220721
  2. The workflow will build the document and upload the contents (the submission package) to that release.
@ronaldtse ronaldtse added the enhancement New feature or request label Dec 5, 2022
@ronaldtse
Copy link
Contributor Author

This feature was also requested by the IHO S-102 project team.

@ronaldtse
Copy link
Contributor Author

Only ISO and IEC utilize Harmonized Stage Codes. Other organizations like OGC have their own stage codes. So the packaging mechanism / file name patterns will have to be different per flavor.

@opoudjis
Copy link
Contributor

all figures named in a zip file that follows DRG directives

Note that metanorma-iso already validates for this.

@ronaldtse
Copy link
Contributor Author

Note that metanorma-iso already validates for this.

Simply validating the file names is not useful by itself -- what is useful is to compile the set of images together for submission to ISO/CS in one archive. The DRG directives specify the folder name as well as file names. The current validation scheme does not actually follow those rules.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: 🆕 New
Development

No branches or pull requests

3 participants