Skip to content

Commit

Permalink
minor: fixed version command in github action
Browse files Browse the repository at this point in the history
  • Loading branch information
AlphaJack committed Mar 16, 2024
1 parent 1a1cdea commit 886b791
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/from_tag_to_build_release_pypi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ jobs:

- name: Store version
id: version
run: ./toc/cli.py --version
run: python -m toc.cli --version

- name: Store partial changelog for release notes
id: changelog
Expand Down
15 changes: 8 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
// │ │ ├── Function-level time
// │ │ ├── Line-level time
// │ │ └── Memory allocation
// │ └── Launching without installing
// │ ├── Launching without installing
// │ └── Release
// │
// └───────────────────────────────────────────────────────────────
-->
Expand Down Expand Up @@ -208,13 +209,13 @@ python -m toc.cli -f "toc/toc.py"

Steps for a new release:

1. Run `toc -lf .tocfiles`
2. Update version in "pyproject.toml"
3. Save changes with `git commit`
4. Add a temporary tag with `git tag v2.6.0`
5. Update the changelog with `git-cliff -c pyproject.toml > CHANGELOG.md`
1. Update version in "pyproject.toml"
2. Save changes with `git commit`
3. Add a temporary tag with `git tag v2.6.0` and rewrite the tag name
4. Update the changelog with `git-cliff -c pyproject.toml > CHANGELOG.md`
5. Run `toc -lf .tocfiles`
6. Remove tag with `git tag --delete v2.6.0`
7. Add changelog changes with `git add CHANGELOG.md && git commit -m "minor: updated CHANGELOG.md"`
8. Add a final tag with `git tag v2.6.0`
8. Move tag to the new commit with `git tag -fa v2.6.0`
9. Upload the new commits and tags with `git push --follow-tags`
10. Update [AUR](https://aur.archlinux.org/packages/toc) version once the new [PyPI](https://pypi.org/project/tableofcontents/) version is online

0 comments on commit 886b791

Please sign in to comment.