New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rework release steps #12

Open

1 task done

patrick-5546 opened this issue Feb 9, 2023 · 2 comments

Owner

patrick-5546 commented Feb 9, 2023 •

edited

Loading

Prerequisites

Add documentation framework #5

Things that need to be done

Update version in pyproject.toml
Generate CHANGELOG.md
- Include in docs using snippets
Tag commit
Build and push to pip
Publish GitHub release
- Should match CHANGELOG.md

Reworked release steps

Step	Method
Update `version` in `pyproject.toml`	manual
Generate `CHANGELOG.md`, tag commit, build and push to pip	run release workflow when "Update version" is pushed to main
Publish GitHub release	Manual, copy from `CHANGELOG.md`

Cleanup

Remove .github/release.yml, the previous release method
Document release steps in docs
Add changelog to project.urls in pyproject.toml

The text was updated successfully, but these errors were encountered:

patrick-5546 added enhancement and removed enhancement labels

Owner Author

patrick-5546 commented Feb 18, 2023 •

edited

Loading

New in mkdocs-material 9.0.13: define multiple aliases as the default version, e..g. stable and rolling

extra:
  version:
    default:
      - stable
      - rolling

Owner Author

patrick-5546 commented Mar 1, 2023

Could use something like https://github.com/release-drafter/release-drafter

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment