Skip to content

Commit 18ae8d4

Browse files
committed
Add section to README on how to make a release
1 parent 1614e52 commit 18ae8d4

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,8 +183,17 @@ hotfix/<branch name>
183183
support/<branch name>
184184
```
185185

186-
Releases are made by simply tagging a release commit on the `main` branch, then creating a GitHub release from that tag.
187-
The release tag should be a SemVer compliant tag, prefixed by `v`, e.g. `v1.2.3`.
186+
### Releases
187+
188+
When making a release, e.g. `v1.2.3`, first update the `_version` number in `venv.sh` to `"v1.2.3"`, then add a new header in the `CHANGELOG.md` file, directly under the `## Unreleased` header, with the version number and date, e.g.
189+
190+
```markdown
191+
## [v1.2.3](https://github.com/SallingGroup-AI-and-ML/venv-cli/releases/tag/v1.2.3) (2025-05-30)
192+
```
193+
194+
The release tag should follow the format `v<major>.<minor>.<patch>`, e.g. `v1.2.3`.
195+
196+
Then commit the changes, push to `main`, and create a new release on GitHub with the same version number as the tag.
188197

189198
## License
190199

0 commit comments

Comments
 (0)