Skip to content
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.

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

Automate release process #150

Open
jwodder opened this issue Jul 8, 2024 · 0 comments
Open

Automate release process #150

jwodder opened this issue Jul 8, 2024 · 0 comments
Labels
CI Continuous integration / continuous deployment setup low priority Less important than other things needs research More information is required under consideration Dev has not yet decided whether or how to implement

Comments

@jwodder
Copy link
Member

jwodder commented Jul 8, 2024

The dandidav release process (documented in doc/releasing.md) involves too many manual steps. As much as possible should be automated.

Goals for the release automation:

  • auto is not allowed.
  • The automation should take care of creating the tag and GitHub Release.
    • How would signing the tag then be handled?
  • The release notes should match the CHANGELOG section for the release, except that multiline paragraphs need to be unwrapped for the former.
  • Changelog items/release notes should be hand-crafted, not automatically generated.
  • Ideally, releasing should be done via a dedicated release PR that gives the maintainer the chance to review the final changelog items.
    • Tagging & GitHub Release creation happens once this PR is merged.

Possible ways to implement this:

  • Use https://github.com/cargo-bins/release-pr to create a release PR with a "release" label, and add a GitHub Actions workflow, triggered on the merge of a "release" PR, that creates the tag and GitHub Release
  • Others???
@jwodder jwodder added needs research More information is required under consideration Dev has not yet decided whether or how to implement low priority Less important than other things CI Continuous integration / continuous deployment setup labels Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous integration / continuous deployment setup low priority Less important than other things needs research More information is required under consideration Dev has not yet decided whether or how to implement
Projects
None yet
Development

No branches or pull requests

1 participant