Skip to content

Commit 0fd51db

Browse files
Add a release template (#441)
* add template * Update .github/ISSUE_TEMPLATE/release.md Co-authored-by: Kyle Shores <kyle.shores44@gmail.com> * Update .github/ISSUE_TEMPLATE/release.md Co-authored-by: Kyle Shores <kyle.shores44@gmail.com> --------- Co-authored-by: Kyle Shores <kyle.shores44@gmail.com>
1 parent ecfd0a9 commit 0fd51db

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

.github/ISSUE_TEMPLATE/release.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Version Release
3+
about: Create an issue to make a new release
4+
title: 'Release X.X.X'
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
## Dependency version update
11+
12+
- [ ] Update musica python package version in `pyproject.toml`
13+
14+
## Testing steps
15+
16+
- [ ] GitHub Actions are passing on `main`
17+
- [ ] Launch Binder and run all tutorial examples
18+
19+
## Deployment and release steps
20+
21+
- [ ] on a new branch (call it anything but `release`)
22+
- [ ] Update the music box version in `python/acom_music_box/__init__.py`
23+
- [ ] Update the music box version in `package.json`
24+
- [ ] Update the `CITATION.cff` file
25+
- [ ] Update version number
26+
- [ ] Ensure all contributors are listed as authors
27+
- [ ] On GitHub, merge `main` into `release`**do NOT squash and merge**
28+
- Alternatively, merge locally and push: `git checkout release && git merge main && git push`
29+
- [ ] Make a tag and add release notes on GitHub
30+
- Be sure to choose the `release` branch for the target
31+
## Python (automatic)
32+
PyPI publishing happens automatically via the release action when a tag and release are created.
33+
34+
- [ ] Verify the PyPI release was published successfully
35+
36+
---
37+
38+
## JavaScript (automatic)
39+
40+
npm publishing happens automatically via the release action when a tag and release are created.
41+
42+
- [ ] Verify the npm release was published successfully

0 commit comments

Comments
 (0)