Skip to content

Commit 5571fb7

Browse files
authored
[Misc] Add release checklist issue template (#1447)
Add the release checklist issue template. Every release manager should create and follow the checklist to do the release step by step. Signed-off-by: wangxiyuan <wangxiyuan1007@gmail.com>
1 parent 5968dff commit 5571fb7

File tree

1 file changed

+100
-0
lines changed

1 file changed

+100
-0
lines changed
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
name: Release Checklist
2+
description: Generate a release checklist issue when prepare a new release.(Used for release team)
3+
title: "[Release]: Release checklist for v"
4+
5+
body:
6+
- type: textarea
7+
attributes:
8+
description: >
9+
Brief info for the new release.
10+
label: Release Checklist
11+
value: >
12+
**Release Version**:
13+
14+
**Release Branch**:
15+
16+
**Release Date**:
17+
18+
**Release Manager**:
19+
- type: textarea
20+
attributes:
21+
description: >
22+
Release notes.
23+
label: Prepare Release Note
24+
value: >
25+
- [ ] Create a new issue for release feedback
26+
27+
- [ ] Write the release note PR.
28+
29+
- [ ] Update the feedback issue link in docs/source/faqs.md
30+
31+
- [ ] Add release note to docs/source/user_guide/release_notes.md
32+
33+
- [ ] Update version info in docs/source/community/versioning_policy.md
34+
35+
- [ ] Update contributor info in docs/source/community/contributors.md
36+
37+
- [ ] Update package version in docs/conf.py
38+
- type: textarea
39+
attributes:
40+
description: >
41+
Make sure the code is merged.
42+
label: PR need Merge
43+
value: >
44+
- [ ] PR link1
45+
46+
- [ ] PR link2
47+
48+
- [ ] ...
49+
- type: textarea
50+
attributes:
51+
description: >
52+
Make sure the new Feature/Function is tested
53+
label: Functional Test
54+
value: >
55+
- [ ] Feature1
56+
57+
- [ ] Bug1
58+
59+
- [ ] ...
60+
- type: textarea
61+
attributes:
62+
description: >
63+
Make sure the doc is updated.
64+
label: Doc Test
65+
value: >
66+
- [ ] Tutorial is updated.
67+
68+
- [ ] User Guide is updated.
69+
70+
- [ ] Developer Guide is updated.
71+
- type: textarea
72+
attributes:
73+
description: >
74+
Make sure the artifacts is ready
75+
label: Prepare Artifacts
76+
value: >
77+
- [ ] Docker image is ready.
78+
79+
- [ ] Wheel package is ready.
80+
- type: textarea
81+
attributes:
82+
description: >
83+
Start to release.
84+
label: Release Step
85+
value: >
86+
- [ ] Release note PR is merged.
87+
88+
- [ ] Post the release on GitHub release page.
89+
90+
- [ ] Generate official doc page on https://app.readthedocs.org/dashboard/
91+
92+
- [ ] Wait for the wheel package to be available on https://pypi.org/project/vllm-ascend
93+
94+
- [ ] Wait for the docker image to be available on https://quay.io/ascend/vllm-ascend
95+
96+
- [ ] Upload 310p wheel to Github release page
97+
98+
- [ ] Brodcast the release news (By message, blog , etc)
99+
100+
- [ ] Close this issue

0 commit comments

Comments
 (0)