Skip to content

Commit 1e596eb

Browse files
authored
Merge pull request #1028 from legumeinfo/release-checklist
Added release checklist issue template
2 parents 27329e7 + 145c007 commit 1e596eb

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Release Checklist
3+
about: A checklist of tasks required to make a release
4+
title: Release MAJOR.MINOR.PATCH
5+
labels: release
6+
assignees: ''
7+
8+
---
9+
10+
- [ ] Create a branch for the release.
11+
- [ ] Update the dependencies. The dependabot PR backlog is not comprehensive and doesn't include transitive dependencies, and merging them one at a time tends to break things, so the best way to do this is manually with `npm`.
12+
- [ ] Do a test build of the NPM package on your **local machine** so you know if something is going off the rails before the automated build action on GitHub.
13+
- [ ] Bump the `"version"` number in `package.json` and reinstall the dependencies so the correct version number is in `package-lock.json`.
14+
- [ ] Update the base image version in the `Dockerfile` if necessary and do a test build and run of the **Docker** image on you local machine so you know if something is going to go off the rails before the automated build action on GitHub.
15+
- [ ] Open a PR that merges the release branch into main.
16+
- [ ] Merge the release PR after it passes testing and review.
17+
- [ ] Tag a corresponding release on GitHub. This will trigger an automated NPM package build on GitHub. If the package build succeeds it will be automatically published to NPM.
18+
- [ ] Update the GHCR image tag in any `compose.prod.yml` files.

0 commit comments

Comments
 (0)