Merge pull request #5 from tbrlpld/prep-dev

Prep dev
tbrlpld · Nov 29, 2023 · b58397c · b58397c
2 parents abe61e3 + 3b79152
commit b58397c
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- ...
+
+### Changed
+
+- ...
+
+### Removed
+
+- ...
+
 ## [0.1.0] - 2023-11-29
 
 ### Added

diff --git a/README.md b/README.md
@@ -315,6 +315,10 @@ To enable the use, you want to set the environment variable `VIRTUALENV_DISCOVER
 This project uses the [Trusted Publisher model for PyPI releases](https://docs.pypi.org/trusted-publishers/).
 This means that publishing is done through GitHub Actions when a [new release is created on GitHub](https://github.com/tbrlpld/laces/releases/new).
 
+To create a release you need a Git tag.
+The tag can either be created on the command line and pushed or in the "create release" interface on GitHub.
+The tag name should be the version number prefixed with a `v` (e.g. `v0.1.0`).
+
 Before publishing a new release, make sure to update the changelog in `CHANGELOG.md` and the version number in `laces/__init__.py`.
 
 To manually test publishing the package, you can use `flit`.