Skip to content

Commit 3428861

Browse files
committed
fix(readme): notes getting the next version number, note on packages to install
1 parent 62e5a1b commit 3428861

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

{{repo_name}}/README.md.jinja

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,22 @@ Run all tests with:
4343

4444
tox -e py
4545

46+
### Package Version
47+
48+
Get the next version number and how the GIT history would be interpreted for that:
49+
50+
pip install python-semantic-release
51+
semantic-release -v version --print
52+
53+
This prints its interpretation of the commits in detail. Make sure to supply the `--print`
54+
argument to not raise the version number which is done automatically by the *release* job
55+
of the GitHub Action Workflows.
56+
4657
### Project template
4758

48-
Update the project configuration from the *copier* template:
59+
Update the project configuration from the *copier* template and make sure the required packages
60+
are installed:
4961

62+
pip install copier jinja2-time
5063
copier update --trust --skip-answered
5164

0 commit comments

Comments
 (0)