Skip to content

Commit 6ec8e0a

Browse files
committed
version string; release instructions
1 parent 23981cb commit 6ec8e0a

File tree

3 files changed

+57
-4
lines changed

3 files changed

+57
-4
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Table of contents:
2828
* [Additional prerequisites](#additional-prerequisites)
2929
* [Testing the production version](#testing-the-production-version)
3030
* [Testing the development version](#testing-the-development-version)
31-
* [Maintaining the version string](#maintaining-the-version-string)
31+
* [Release activities](#release-activities)
3232

3333
## Preface
3434

@@ -444,6 +444,6 @@ The procedure is the same as for testing the production version, except for step
444444
npm run dev-with-path
445445
```
446446

447-
### Maintaining the version string
447+
### Release activities
448448

449-
Maintain the version string [here](./main/src/version.js) according to the rules in that file.
449+
See [RELEASE.md](./RELEASE.md).

RELEASE.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
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)`.

main/src/version.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// Maintain the version string on the development branch:
22
// - during development: set to (unreleased);
33
// - right before merging to the main branch for making a new release: set to the new release tag (see https://github.com/SolidLabResearch/generic-data-viewer-react-admin/tags).
4-
const version = "(unreleased)";
4+
const version = "v1.7.0";
55
export default version;

0 commit comments

Comments
 (0)