Skip to content

Commit 4b78bb8

Browse files
committed
add release checklist template (WIP)
1 parent ac553b9 commit 4b78bb8

File tree

1 file changed

+109
-0
lines changed

1 file changed

+109
-0
lines changed

.github/ISSUE_TEMPLATE/release.yml

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
name: 🚀 Release Checklist
3+
description: >
4+
The release checklist is the document that outlines the steps and tasks that
5+
need to be completed before a software release.
6+
It serves as a guide for the development team to ensure that all necessary tasks
7+
are completed and all necessary stakeholders are informed before the release is made.
8+
The checklist typically includes tasks related to code review, testing, documentation, and communication.
9+
By using a release checklist, teams can ensure that releases are smooth, efficient, and successful.
10+
labels:
11+
- release
12+
13+
body:
14+
- type: markdown
15+
attributes:
16+
value: >
17+
# Release Process
18+
19+
- [ ] Change the version in __init__.py and setup.py
20+
21+
```bash
22+
export VERSION=0.0.0
23+
```
24+
25+
- [ ] Commit these changes with the message: "Release: VERSION"
26+
27+
```bash
28+
git commit -m "Release: ${VERSION}"
29+
```
30+
31+
- [ ] Add a tag in git to mark the release:
32+
33+
```bash
34+
"git tag VERSION -m 'Adds tag VERSION for pypi'
35+
```
36+
37+
- [ ] Push the tag to git
38+
39+
```bash
40+
git push --tags origin main
41+
```
42+
43+
- [ ] Run the following commands in the top-level directory:
44+
45+
```bash
46+
python setup.py bdist_wheel
47+
python setup.py sdist
48+
```
49+
50+
- [ ] Upload the package to the pypi __test__ server __first__:
51+
52+
```bash
53+
twine upload dist/* -r pypitest
54+
twine upload dist/* -r pypitest --repository-url=https://test.pypi.org/legacy/
55+
```
56+
57+
- [ ] Check that you can install it in a virtualenv by running:
58+
59+
```bash
60+
pip install -i https://testpypi.python.org/pypi trlx
61+
trlx env
62+
trlx test
63+
```
64+
65+
- [ ] Upload the final version to actual pypi:
66+
67+
```bash
68+
twine upload dist/* -r pypi
69+
```
70+
71+
- [ ] Add release notes to the tag in github
72+
73+
```markdown
74+
# [0.0.0](https://github.com/CarperAI/trlx/compare/v0.0.0...v0.0.1) (2023-01-01)
75+
76+
> Description
77+
78+
### Upgrade Steps
79+
* [ACTION REQUIRED]
80+
*
81+
82+
### Breaking Changes
83+
*
84+
*
85+
86+
### New Features
87+
*
88+
*
89+
90+
### Bug Fixes
91+
*
92+
*
93+
94+
### Performance Improvements
95+
*
96+
*
97+
98+
### Other Changes
99+
*
100+
*
101+
102+
# Release checklist
103+
```
104+
105+
- [ ] Update the version in __init__.py, setup.py to the new version "-dev" and push to master
106+
107+
```bash
108+
109+
```

0 commit comments

Comments
 (0)