Skip to content

Commit

Permalink
Merge pull request rst2pdf#1256 from akrabat/dynamic-versions
Browse files Browse the repository at this point in the history
Support dynamic versions for releasing with uv
  • Loading branch information
akrabat authored Dec 24, 2024
2 parents 92b9a09 + a066ba0 commit c705828
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 7 deletions.
21 changes: 14 additions & 7 deletions doc/RELEASE_PROCESS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,25 @@ This is an outline of what needs to be done in order to release rst2pdf.

$ git checkout main

#. Use changelog-generator_ (or similar) to create a changelog
#. Use changelog-generator_ (or similar) to create a changelog for the tag's message

::

$ changelog-generator -u rst2pdf -r rst2pdf -m 999
$ changelog-generator -u rst2pdf -r rst2pdf -m {id of milestone}

#. Tag release with version number e.g.

::

$ git tag -s 0.94
$ git push upstream 0.94
$ git tag -s 0.103

#. Update the uv.lock file with the correct version number, move the tag and push

$ uv lock
$ git add uv.lock
$ git commit -m "Update uv.lock for version 0.103"
$ git tag -s 0.103 -f
$ git push upstream 0.103

#. Build manual

Expand All @@ -36,7 +43,7 @@ This is an outline of what needs to be done in order to release rst2pdf.

::

$ git checkout 0.94
$ git checkout 0.103
$ uv sync --all-extras

Generate the HTML and PDF docs:
Expand All @@ -50,7 +57,7 @@ This is an outline of what needs to be done in order to release rst2pdf.

::

$ exiftool -PDF:Subject="v0.94 r2019011700" doc/output/pdf/manual.pdf
$ exiftool -PDF:Subject="v0.103 r2019011700" doc/output/pdf/manual.pdf
$ exiftool -PDF:Author="rst2pdf project; Roberto Alsina" doc/output/pdf/manual.pdf

and upload to HTML and PDF to the website
Expand Down Expand Up @@ -94,7 +101,7 @@ This is an outline of what needs to be done in order to release rst2pdf.
::

$ uvx -n --index-url https://test.pypi.org/simple --extra-index-url https://pypi.org/simple --prerelease allow \
--index-strategy unsafe-best-match rst2pdf@0.101rc1 tests/input/test_tableofcontents.rst
--index-strategy unsafe-best-match rst2pdf@0.103rc1 tests/input/test_tableofcontents.rst

#. Delete the build artifacts and dist files with:

Expand Down
3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ Releases = "https://github.com/rst2pdf/rst2pdf/releases"
Source = "https://github.com/rst2pdf/rst2pdf"
"Bug Reports" = "https://github.com/rst2pdf/rst2pdf/issues"

[tool.uv]
cache-keys = [{ git = { commit = true, tags = true } }]

[tool.black]
line-length = 88
target-version = ['py36']
Expand Down

0 comments on commit c705828

Please sign in to comment.