Skip to content

Commit 0a22a26

Browse files
committed
Update README_CONTRIBUTORS_AND_MAINTAINERS.md
1 parent b0dee99 commit 0a22a26

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README_CONTRIBUTORS_AND_MAINTAINERS.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,8 @@ To release a new version, follow these steps:
177177
### Creating the release
178178

179179
- Choose a new version number according to the [Semantic Versioning](https://semver.org/) scheme.
180-
- Create a new tag for the new version with the following command (making sure you are on the commit you want to tag as the release (usually the most recent one)):
180+
- Make sure that you are on the commit you want to tag as the release (usually the most recent one).
181+
- Create a new tag for the new version with the following command:
181182
```shell
182183
$ git tag -a <tag> -m "<description>"
183184
```
@@ -189,10 +190,13 @@ To release a new version, follow these steps:
189190
It is important that the tag name starts with a lowercase `v` followed by the version number (meaning it must match `v*.*.*`).
190191
- Push the tag to the repository:
191192
```shell
192-
$ git push origin tag v1.2.3
193+
$ git push # push the changes
194+
$ git push origin tag <tag> # push the tag
193195
```
196+
(replace `<tag>` with the tag name, e.g., `v1.2.3`)
197+
194198
This automatically triggers GitHub actions to do the following things (defined in the [.github/workflows/](.github/workflows/) directory):
195-
- Publish the documentation on GitHub Pages.
199+
- Compile and publish the documentation on GitHub Pages.
196200
- Create a release draft on GitHub with the single-header include file already attached.
197201
- Edit the release draft in the [releases section on GitHub](https://github.com/ti-uni-bielefeld/T-SIMD/releases) to add the changelog and other information. See the previous releases for examples.
198202
- Note that you might have to wait a few moments for the GitHub actions to finish before the release draft appears.

0 commit comments

Comments
 (0)