ga4gh / gh-openapi-docs

Package for building OpenAPI schema docs and UI for gh-pages
Apache License 2.0
7 stars 5 forks source link

Identify and document the release procedure #85

Open tschaffter opened 2 years ago

tschaffter commented 2 years ago

Document how to create a new release of this project. The artifact generated is an npm package published to npmjs and possibly documentation saved to GH Pages.

@jb-adams Do you have a preferred way to generate the release? I currently use release-it in several projects.

Example of configuration file: https://github.com/Sage-Bionetworks/rocc-app/blob/main/.release-it.json Example of documentation: https://github.com/Sage-Bionetworks/rocc-app/blob/main/.github/CONTRIBUTING.md#release-procedure

One day I was thinking to try semver in one of my project to trigger the creation of the GitHub releases.