Skip to content

Commit 4170da9

Browse files
committed
📚 Add basic release documentation for template package
1 parent 35d3580 commit 4170da9

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

‎docs/developer.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,15 @@ To run these scripts, you need to specify the `docs` environment in the `hatch r
4040

4141
The `docs:deploy` script will use `mkdocs gh-deploy` to deploy the documentation as a GitHub Pages website.
4242
This should rarely be done manually, since we have a GitHub Action set up to do this.
43+
44+
## Release
45+
46+
To make a new release of the template package, simply tag the commit you want to release:
47+
48+
git tag -a v0.3.0 -m '🚀 Release `v0.3.0`'
49+
50+
And then push the tag to the remote, here named `origin`:
51+
52+
git push origin --tags
53+
54+
You can the go to the [Github releases](https://github.com/mbercx/python-copier/releases) and make a new release based on the new tag.

0 commit comments

Comments
 (0)