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

docs: add RELEASING.md doc #488

Merged
merged 1 commit into from
Aug 24, 2024
Merged

docs: add RELEASING.md doc #488

merged 1 commit into from
Aug 24, 2024

Conversation

tombh
Copy link
Collaborator

@tombh tombh commented Aug 14, 2024

I'm surprised I hadn't made this already. Maybe I did but it's somewhere else?

Let's maybe do a release before merging this, so as to check that it's accurate.

Code review checklist (for code reviewer to complete)

  • Pull request represents a single change (i.e. not fixing disparate/unrelated things in a single PR)
  • Title summarizes what is changing
  • Commit messages are meaningful (see [this][commit messages] for details)
  • Tests have been included and/or updated, as appropriate
  • Docstrings have been included and/or updated, as appropriate
  • Standalone docs have been updated accordingly

@tombh tombh requested a review from alcarney August 14, 2024 14:13
@tombh tombh force-pushed the tombh/doc-about-releaseing branch from 636b72a to aca1daa Compare August 14, 2024 14:16
alcarney
alcarney previously approved these changes Aug 14, 2024
Copy link
Collaborator

@alcarney alcarney left a comment

Choose a reason for hiding this comment

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

Looks good to me! :)

@tombh tombh force-pushed the tombh/doc-about-releaseing branch from aca1daa to 06acc80 Compare August 18, 2024 15:17
@tombh tombh force-pushed the tombh/doc-about-releaseing branch from 06acc80 to 8f24814 Compare August 18, 2024 15:19
@tombh tombh mentioned this pull request Aug 24, 2024
6 tasks
@alcarney alcarney mentioned this pull request Aug 24, 2024
6 tasks
@tombh tombh force-pushed the tombh/doc-about-releaseing branch from 8f24814 to 6c8941a Compare August 24, 2024 20:14
- In the "Choose a tag" dropdown button, type the new version number.
- Click the "Generate release notes" button.
- Generating release notes does not require making an actual release, so you may like to copy and paste the output of the release notes to make the above release PR more informative.
- Click the green "Publish release button".
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe add a note to check the "Set as a pre-release" button if required.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks, done ☑️

@tombh tombh force-pushed the tombh/doc-about-releaseing branch from 6c8941a to 8d9c77d Compare August 24, 2024 20:43
@tombh tombh force-pushed the tombh/doc-about-releaseing branch from 8d9c77d to 11644dc Compare August 24, 2024 20:44
@tombh tombh merged commit 68d6408 into main Aug 24, 2024
16 checks passed
@tombh tombh deleted the tombh/doc-about-releaseing branch August 24, 2024 20:48
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.

2 participants