Skip to content

Commit

Permalink
release workflow: fix commit command and add "Update scripts at HF ..…
Browse files Browse the repository at this point in the history
…." step
  • Loading branch information
ArneBinder committed Nov 27, 2023
1 parent 437334b commit 7938cc6
Showing 1 changed file with 19 additions and 18 deletions.
37 changes: 19 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -346,24 +346,25 @@ pytest --cov --cov-report term-missing

### Releasing

1. Create the release branch:
`git switch --create release main`
2. Increase the project version:
`poetry version <PATCH|MINOR|MAJOR>`,
e.g. `poetry version patch` for a patch release. If the release contains new features, or breaking changes,
bump the minor version (this project has no main release yet). If the release contains only bugfixes, bump
the patch version. See [Semantic Versioning](https://semver.org/) for more information.
3. Increase the maximum version in all dataset `requirements.txt` files, if not a patch release.
4. Commit the changes:
`git commit --message="release <NEW VERSION>" pyproject.toml`,
e.g. `git commit --message="release 0.13.0" pyproject.toml`
5. Push the changes to GitHub:
`git push origin release`
6. Create a PR for that `release` branch on GitHub.
7. Wait until checks passed successfully.
8. Merge the PR into the main branch. This triggers the GitHub Action that creates all relevant release
artefacts and also uploads them to PyPI.
9. Cleanup: Delete the `release` branch. This is important, because otherwise the next release will fail.
01. Create the release branch:
`git switch --create release main`
02. Increase the project version:
`poetry version <PATCH|MINOR|MAJOR>`,
e.g. `poetry version patch` for a patch release. If the release contains new features, or breaking changes,
bump the minor version (this project has no main release yet). If the release contains only bugfixes, bump
the patch version. See [Semantic Versioning](https://semver.org/) for more information.
03. Increase the maximum version in all dataset `requirements.txt` files, if not a patch release.
04. Commit the changes:
`git commit --message="release <NEW VERSION>" -a`,
e.g. `git commit --message="release 0.13.0" -a`
05. Push the changes to GitHub:
`git push origin release`
06. Create a PR for that `release` branch on GitHub.
07. Wait until checks passed successfully.
08. Merge the PR into the main branch. This triggers the GitHub Action that creates all relevant release
artefacts and also uploads them to PyPI.
09. Cleanup: Delete the `release` branch. This is important, because otherwise the next release will fail.
10. Update the scripts at [huggingface.co/pie](https://huggingface.co/pie) with the new versions.

[black]: https://github.com/psf/black
[codecov]: https://app.codecov.io/gh/arnebinder/pie-datasets
Expand Down

0 comments on commit 7938cc6

Please sign in to comment.