Skip to content

Commit

Permalink
Add Release section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
CAMOBAP committed Sep 8, 2023
1 parent 65c19df commit 8658db3
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,35 @@ are installed. Please refer to the following table for them.
Refer to https://www.metanorma.org/install/usage[Metanorma CLI usage].


== Release

=== General overview

Once we are ready for release of `metanorma-cli`, it means:
- required all `metanorma-cli`'s dependencies are released or ready for upcoming release
- last `rake` workflow for `main` branch is green (can be started https://github.com/metanorma/metanorma-cli/actions/workflows/rake.yml[manually])

Simply bump `metanorma-cli` gem version and push. This will initiate rake workflow that:
- run `rake` tests
- run `template`s compilation tests
- run `sample`s compilation tests

The test matrix defined as JSON files in link:./.github/workflows/samples-smoke-matrix.json[samples test matrix] and link:./.github/workflows/templates-smoke-matrix.json[templates test matrix]

One all tests is passed, `packed-mn`'s and `docker`'s releases will be initiated

=== Responsibility

[cols="1,1,1"]
|===
|Repositories | Responsible

|`metanorma-cli`'s dependencies (including transitive) from the GitHub `metanorma` organization
|@opoudjis

|`packed-mn`, `docker`, `chocolatey`, `snap`, `brew` and any other unusual CI failures
|@CAMOBAP

== Credits

This gem is developed, maintained and funded by https://www.metanorma.com/docs/getting-started/[Ribose Inc.]
Expand Down

0 comments on commit 8658db3

Please sign in to comment.