Skip to content

Commit 8fc7a87

Browse files
committed
release tags must start with "v"
1 parent 9ff317a commit 8fc7a87

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

.github/workflows/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ To be completed.
2020
## Publish To PyPi
2121

2222
This workflow publishes the `micropython-europi` and `micropython-europi-contrib` distributions to the public PyPi
23-
repositories. These distributions are described by the [`software/firmware/setup.py`](/software/firmware/setup.py) and [`software/setup.py`](/software/setup.py) files respectively.
23+
repositories. These distributions are described by the [`software/firmware/setup.py`](/software/firmware/setup.py) and [`software/setup.py`](/software/setup.py) files respectively.
2424

2525
### test.pypi.org
2626

@@ -31,14 +31,14 @@ exercise the release process. Most of these will fail silently as a specific ver
3131

3232
Pushes to the main [pypi.org](https://pypi.org/project/micropython-europi/#history) occur with each new tag.
3333

34-
### Release process
34+
## Release process
3535

3636
1. Decide which version number to release.
3737
1. Update [`software/firmware/version.py`](/software/firmware/version.py) with the new version number.
3838
1. Commit and push to `main`.
3939
1. Verify that the new release was pushed to [test.pypi.org](https://test.pypi.org/project/micropython-europi/#history). If it was not, look for errors associated with the commit on the [actions tab](https://github.com/Allen-Synthesis/EuroPi/actions). Commit new changes until a successful release is created.
40-
1. Tag the release locally using `git tag -a <version_number> -m 'message'`, for example `git tag -a 0.0.1 -m 'release v0.0.1'`
41-
1. Push the tag to the remote repository with `git push origin <version_number>`, for example `git push origin 0.0.1`.
40+
1. Tag the release locally using `git tag -a v<version_number> -m 'message'`, for example `git tag -a v0.0.1 -m 'release v0.0.1'`
41+
1. Push the tag to the remote repository with `git push origin <version_number>`, for example `git push origin v0.0.1`.
4242
1. Verify that the new release was pushed to [pypi.org](https://pypi.org/project/micropython-europi/#history) and is installable.
4343
1. Update the generated [GitHub Release](https://github.com/Allen-Synthesis/EuroPi/releases) with a description of the changes and publish.
4444
1. Announce the release to the Discord server.

0 commit comments

Comments
 (0)