diff --git a/docs/contributing/publishing-a-new-release.md b/docs/contributing/publishing-a-new-release.md index ae02acd..6db8e4d 100644 --- a/docs/contributing/publishing-a-new-release.md +++ b/docs/contributing/publishing-a-new-release.md @@ -1,6 +1,7 @@ # Publishing a new release Let's create a release from time to time, every 1 or 2 months for instance, to contain enough changes, but not too much. +Before beginning, you should ensure that ZDEMO_EXCEL_CHECKER (in the demos repo) shows all green checkmarks. Below are the notes taken while publishing the release `7.16.0`. @@ -24,7 +25,7 @@ Now [create the release in GitHub](https://docs.github.com/en/repositories/relea - Click "Releases" - Click "Draft a new release" - Click "Choose a tag" -- Type the title, select the previous tag, click "Auto-generate release notes" and click "Preview" to verify; you should have a list with the changes from the previous release, edit as required: +- Type the title, select the previous tag, click "Auto-generate release notes" and click "Preview" to verify; you should have a list with the changes from the previous release, edit as required and remember to include the list below as explanation: - `+`: new feature - `*`: bug fix - `!`: feature modification @@ -32,3 +33,6 @@ Now [create the release in GitHub](https://docs.github.com/en/repositories/relea - Click "Publish release" - It's done, zip and tar.gz files are automatically assigned to the release - The new release appears in the Code home page, with the changelog in the release page itself. + +Now create a release for the [demos](https://github.com/abap2xlsx/demos) repository as well: use the same process and tag the latest commit available at the time the main library is released, to ensure users will always have a matching set of demo programs. +