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.

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

Create release issue template #186

Merged
merged 4 commits into from
Nov 7, 2023
Merged

Create release issue template #186

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1e1261f
create release checklist
allyhawkins Nov 7, 2023
b711dbd
clarify comment
allyhawkins Nov 7, 2023
76e1d5d
Apply suggestions from code review
allyhawkins Nov 7, 2023
5cc8964
remove extra the
allyhawkins Nov 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/release-checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Release checklist
about: Prepare for a new release of scpca-docs
title: Prepare for scpca-docs release
labels: release
assignees: ''

---

## Steps for a new release of `scpca-docs`
<!-- Please include any notes about what will be included in this release -->
<!-- e.g., you might want to mention if the release is related to a specific portal feature, like addition of AnnData objects -->
<!-- Update the title of this issue to reflect the contents of the release (e.g., Prepare for scpca-docs release: AnnData) -->

### Preparing for the release
- [ ] Does this release require an update to the CHANGELOG because there will be changes to downloadable files? If so, please create an issue tracking the CHANGELOG update and mark it as blocking this issue.
- [ ] Are all other issues planned for this release resolved? If any issues are unresolved, mark this issue as blocked by those on ZenHub.
- [ ] Optional: If not all changes in `development` are ready to be released, create a feature branch off `main` and cherry pick commits from `development` to that feature branch.
- [ ] File a PR from the `development` branch (or the new feature branch) to the `main` branch. This should include all of the changes that will be associated with the next release.

### Creating a release
- [ ] On the [releases page](https://github.com/AlexsLemonade/scpca-nf/releases), choose `Draft a new release`.
- [ ] In `Choose a tag`, use the current date as the release tag (`YYYY.MM.DD`), then click `Create a new tag: YYYY.MM.DD on publish`.
- [ ] Write a description of the major changes in this release. You may want to start with the auto-generated release notes to save time.
- [ ] Optional: If not all issues have been addressed, save a draft to return to later.
- [ ] Publish the release!
Loading