|
| 1 | +# Release activities |
| 2 | + |
| 3 | +* [Release tag](#release-tag) |
| 4 | +* [Finalize work on the development branch](#finalize-work-on-the-development-branch) |
| 5 | +* [Merge to the main branch](#merge-to-the-main-branch) |
| 6 | +* [Create a new release](#create-a-new-release) |
| 7 | +* [Back on the development branch](#back-on-the-development-branch) |
| 8 | + |
| 9 | +## Release tag |
| 10 | + |
| 11 | +Define the release tag. Example: `v1.7.0`. |
| 12 | + |
| 13 | +> Dut do not create the tag in git yet. |
| 14 | +
|
| 15 | +## Finalize work on the development branch |
| 16 | + |
| 17 | +All feature branches and fix branches should be merged here |
| 18 | +and [CHANGELOG.md](./CHANGELOG.md) should reflect all modifications under the `## [Unreleased]` section. |
| 19 | + |
| 20 | +In [CHANGELOG.md](./CHANGELOG.md): |
| 21 | + |
| 22 | +* Create the new release section by adding a new release title line below the `## [Unreleased]` title line. Example: `## [1.7.0] - 2025-04-09`. |
| 23 | +* Add a new release link line near the end of the file. Example: `[1.7.0]: https://github.com/SolidLabResearch/generic-data-viewer-react-admin/releases/tag/v1.7.0`. |
| 24 | +* Update the `[Unreleased]` link in the bottom line to use the new release tag. Example: `[Unreleased]: https://github.com/SolidLabResearch/generic-data-viewer-react-admin/compare/v1.7.0...HEAD` |
| 25 | + |
| 26 | +Enter the release tag in the version string in [/main/src/version.js](./main/src/version.js). |
| 27 | + |
| 28 | +## Merge to the main branch |
| 29 | + |
| 30 | +Go to the github web interface. |
| 31 | + |
| 32 | +Make a pull request (example: `Merging for v1.7.0`) from the development branch to the main branch. |
| 33 | + |
| 34 | +Merge, without squashing (!). |
| 35 | + |
| 36 | +## Create a new release |
| 37 | + |
| 38 | +Still in the github web interface... |
| 39 | + |
| 40 | +Create the new release from the main branch. |
| 41 | + |
| 42 | +Enter the to be created new git tag here. |
| 43 | + |
| 44 | +In the release description, copy from [CHANGELOG.md](./CHANGELOG.md): |
| 45 | + |
| 46 | +* the new release section created above |
| 47 | +* the new release link created above |
| 48 | + |
| 49 | +Make sure to set the release as the latest release. |
| 50 | + |
| 51 | +## Back on the development branch |
| 52 | + |
| 53 | +Modify the version string in [/main/src/version.js](./main/src/version.js) back to `(unreleased)`. |
0 commit comments