Skip to content

Commit ec8a29b

Browse files
authored
Merge pull request #11 from Ericgig/doc.release_note
Add release notes
2 parents 2889034 + 7a79777 commit ec8a29b

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

doc/release_distribution.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Release Procedure for qutip-cuquantum
2+
3+
#### Major and Minor Releases (e.g., v0.1.0, v0.2.0)
4+
5+
- Create a new branch named qutip-cuquantum-A.B.X, where A.B is the major/minor version number.
6+
7+
- Update the VERSION file for Release. Remove the .dev suffix from the version number. `alpha`, `beta`, `post` tag are acceptable.
8+
9+
- Increment Version on main. Edit the VERSION file and increment the version number, resetting the dev number. For example, if you are releasing `v0.1.0`, the version on main should become `v0.2.0.dev1`.
10+
11+
12+
#### Micro/Patch Releases (e.g., v0.1.1)
13+
14+
- Make a branch off the release branch.
15+
- Cherry-Pick changes to include from main.
16+
- Increment the VERSION file
17+
- Merge into the release branch with a pull request.
18+
19+
#### Deployment
20+
21+
- Go to the "Releases" page on the GitHub repository and draft a new release.
22+
- Create a new tag with the scheme vA.B.C (e.g., v0.1.0) targeting your release branch (qutip-cuquantum-0.1.X).
23+
- Write the changelog into the release description.
24+
- Publishing the release will trigger the GitHub Action to build and publish the package to PyPI.

0 commit comments

Comments
 (0)