Skip to content

Commit acdef1b

Browse files
committed
Update release guide
1 parent 5e9b7a1 commit acdef1b

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

docs/ReleaseGuide.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,13 @@ The release of the `FANS` repository is made directly from a release branch call
66

77
1. Create a branch called `FANS-v1.2.3` from the latest commit of the `develop` branch.
88

9-
2. If it is a real release, [open a Pull Request `main` <-- `FANS-v1.2.3`](https://github.com/DataAnalyticsEngineering/FANS/compare/main...main) named after the version (i.e. `Release v1.2.3`) and briefly describe the new features of the release in the PR description.
9+
2. Bump the version in the `CHANGELOG.md`, the base `CMakeLists.txt`, and in the file `FANS_Dashboard/pyproject.toml` on the branch `FANS-v1.2.3`.
1010

11-
3. Bump the version in the `CHANGELOG.md` and the base `CMakeLists.txt` on the branch `FANS-v1.2.3`.
11+
3. Assuming you have pixi installed, run the command `pixi lock` in the base directory file to update the version of the FANS dashboard in the pixi lock file.
1212

13-
4. [Draft a new release](https://github.com/DataAnalyticsEngineering/FANS/releases/new) in the `Releases` section of the repository page in a web browser. The release tag needs to be the exact version number (i.e.`v1.2.3` or `v1.2.3rc1`, compare to [existing tags](https://github.com/DataAnalyticsEngineering/FANS/tags)). Use `@target:main`. Release title is also the version number (i.e. `v1.2.3` or `v1.2.3rc1`, compare to [existing releases](https://github.com/DataAnalyticsEngineering/FANS/tags)).
13+
4. If it is a real release, [open a Pull Request `main` <-- `FANS-v1.2.3`](https://github.com/DataAnalyticsEngineering/FANS/compare/main...main) named after the version (i.e. `Release v1.2.3`) and briefly describe the new features of the release in the PR description.
14+
15+
5. [Draft a new release](https://github.com/DataAnalyticsEngineering/FANS/releases/new) in the `Releases` section of the repository page in a web browser. The release tag needs to be the exact version number (i.e.`v1.2.3` or `v1.2.3rc1`, compare to [existing tags](https://github.com/DataAnalyticsEngineering/FANS/tags)). Use `@target:main`. Release title is also the version number (i.e. `v1.2.3` or `v1.2.3rc1`, compare to [existing releases](https://github.com/DataAnalyticsEngineering/FANS/tags)).
1416

1517
* *Note:* If it is a pre-release then the option *This is a pre-release* needs to be selected at the bottom of the page. Use `@target:FANS-v1.2.3` for a pre-release, since we will never merge a pre-release into `main`.
1618
* Use the `Auto-generate release notes` feature.
@@ -19,6 +21,6 @@ The release of the `FANS` repository is made directly from a release branch call
1921

2022
b) If this is a "real" release: As soon as one approving review is made, merge the release PR (from `FANS-v1.2.3`) into `main`.
2123

22-
5. Merge `main` into `develop` for synchronization of `develop`.
24+
6. Merge `main` into `develop` for synchronization of `develop`.
2325

24-
6. If everything is in order up to this point then the new version can be released by hitting the "Publish release" button in your Release Draft. This will create the corresponding tag.
26+
7. If everything is in order up to this point then the new version can be released by hitting the "Publish release" button in your Release Draft. This will create the corresponding tag.

0 commit comments

Comments
 (0)