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

Create release issue template #186

Merged
merged 4 commits into from
Nov 7, 2023
Merged

Conversation

allyhawkins
Copy link
Member

Closes #175

This PR adds a new issue template with a checklist for releases. I used a similar format to the release template that we have in scpca-nf. I also tried to add some instructions to help if people are only releasing part of the updates that are present in development, especially because we are about to do that. Please check to make sure the instructions and additional comments are clear.

One thing that I didn't do was add a version tag in the issue title. We have that for other release checklists, but here the tag is based on the day the docs get released. So instead, I added a note about updating the title to include the expected contents of the release. If others feel strongly about including the version tag in the title, then I can add that back in.

Copy link
Member

@jaclyn-taroni jaclyn-taroni 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 overall. I'm returning one comment I think we should discuss!

.github/ISSUE_TEMPLATE/release-checklist.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release-checklist.md Outdated Show resolved Hide resolved
@allyhawkins
Copy link
Member Author

Okay, I incorporated the suggestion for the changelog checkbox. This should be ready for another look @jaclyn-taroni.

Copy link
Member

@jaclyn-taroni jaclyn-taroni left a comment

Choose a reason for hiding this comment

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

👍🏻

@jaclyn-taroni
Copy link
Member

I'm going to merge this so I can use it!

@jaclyn-taroni jaclyn-taroni merged commit a9c5aa1 into main Nov 7, 2023
1 check passed
@jaclyn-taroni jaclyn-taroni deleted the allyhawkins/release-checklist branch November 7, 2023 20:31
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.

Create an issue template for new releases of docs
2 participants