File tree Expand file tree Collapse file tree 2 files changed +15
-6
lines changed Expand file tree Collapse file tree 2 files changed +15
-6
lines changed Original file line number Diff line number Diff line change @@ -10,11 +10,10 @@ Please make sure to always provide a patch version number (i.e. use a version
10
10
number with * three* levels such as ` 1.0.0 ` instead of ` 1.0 ` ).
11
11
12
12
``` sh title="shell"
13
- # edit version number in pyproject.toml
14
- git add pyproject.toml
15
- git commit -m " release vX.Y.Z"
16
- git tag -a vX.Y.Z
17
- git push --follow-tags
13
+ just release X.Y.Z
18
14
```
19
15
20
- Releasing on PyPI is then performed automatically by a GitHub action workflow.
16
+ This will update the version number to ` X.Y.Z ` and create an annotated tag for
17
+ you. Once you've written the release notes, check the created commit. If
18
+ satisfactory, ` git push --follow-tags ` will trigger publication on PyPI via a
19
+ GitHub Action.
Original file line number Diff line number Diff line change 25
25
# invoke mkdocs with appropriate dependencies
26
26
mkdocs * FLAGS :
27
27
uv run --with-requirements=docs/ requirements.txt -- mkdocs {{ FLAGS}}
28
+
29
+ release version :
30
+ @ if [ -n " $(git status --porcelain || echo " dirty" )" ]; then echo " repo is dirty!" ; exit 1 ; fi
31
+ sed -i ' s/^version = ".*"$/version = "{{ version }} "/g' pyproject.toml
32
+ git add pyproject.toml
33
+ sed -i ' s/"stagpy~=.*"/"stagpy~={{ version }} "/g' docs/ user-guide/ install.md
34
+ git add docs/ user-guide/ install.md
35
+ git commit -m " release {{ version }} "
36
+ git tag -m " Release {{ version }} " -a -e " v{{ version }} "
37
+ @ echo " check last commit and ammend as necessary, then git push --follow-tags"
You can’t perform that action at this time.
0 commit comments