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

Add instructions for releasing #241

Merged
merged 4 commits into from
Feb 22, 2022
Merged

Add instructions for releasing #241

merged 4 commits into from
Feb 22, 2022

Conversation

gadomski
Copy link
Member

@gadomski gadomski commented Feb 16, 2022

Related Issue(s): Closes #221

Description: Adds documentation on the release procedure. Generated during the v0.2.6 release. cc @sgillies.

PR checklist:

  • Code is formatted (run scripts/format).
  • Code lints properly (run scripts/lint).
  • Tests pass (run scripts/test).
  • Documentation has been updated to reflect changes, if applicable.
  • Changes are added to the CHANGELOG.

Copy link

@duckontheweb duckontheweb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me. Have you considered using a tool like tbump or bump2version to automate some of the file updates. You might be able to template the changes to the CHANGELOG with bump2version as well, though I'm not sure about that.

@gadomski gadomski merged commit 1499fd1 into main Feb 22, 2022
@gadomski gadomski deleted the issues/221-releasing branch February 22, 2022 20:56
@gadomski
Copy link
Member Author

https://github.com/dmerejkowsky/tbump

I had not seen this, but it looks very nice -- the current way is clunky. I'll open an issue to look into it, thanks!

@gadomski gadomski mentioned this pull request Feb 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the release procedure
2 participants