Skip to content

Commit 3196fcb

Browse files
shmuelkshmuelk
authored
Added new issue templates (#114)
Signed-off-by: Shmuel Kallner <[email protected]>
1 parent 71c3b3c commit 3196fcb

File tree

5 files changed

+190
-0
lines changed

5 files changed

+190
-0
lines changed

‎.github/ISSUE_TEMPLATE/blank_issue.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: Blank Issue
3+
about: Create a new issue from scratch
4+
title: ''
5+
labels: needs-triage
6+
assignees: ''
7+
8+
---

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug you encountered
4+
title: ''
5+
labels: kind/bug, needs-triage
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Please use this template while reporting a bug and provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner. Thanks!
11+
12+
-->
13+
14+
**What happened**:
15+
16+
**What you expected to happen**:
17+
18+
**How to reproduce it (as minimally and precisely as possible)**:
19+
20+
**Anything else we need to know?**:
21+
22+
**Environment**:
23+
- Kubernetes version (use `kubectl version`):
24+
- llm-d-inference-sim version (use `git describe --tags --dirty --always` if you built from source, or specify the tag if you used a tagged version or image):
25+
- Cloud provider or hardware configuration:
26+
- Install tools:
27+
- Others:

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: needs-triage
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Please only use this template for submitting enhancement requests -->
11+
12+
**What would you like to be added**:
13+
14+
**Why is this needed**:

‎.github/ISSUE_TEMPLATE/new-release.md‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
---
2+
name: New Release
3+
about: Propose a new release
4+
title: Release v0.x.0
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
- [Introduction](#introduction)
11+
- [Prerequisites](#prerequisites)
12+
- [Release Process](#release-process)
13+
- [Announce the Release](#announce-the-release)
14+
- [Final Steps](#final-steps)
15+
16+
## Introduction
17+
18+
This document defines the process for releasing llm-d-inference-sim.
19+
20+
## Prerequisites
21+
22+
1. Permissions to push to the llm-d-inference-sim repository.
23+
24+
2. Set the required environment variables based on the expected release number:
25+
26+
```shell
27+
export MAJOR=0
28+
export MINOR=1
29+
export PATCH=0
30+
export REMOTE=origin
31+
```
32+
33+
3. If creating a release candidate, set the release candidate number.
34+
35+
```shell
36+
export RC=1
37+
```
38+
39+
## Release Process
40+
41+
1. If needed, clone the llm-d-inference-sim [repo].
42+
43+
```shell
44+
git clone -o ${REMOTE} [email protected]:llm-d/llm-d-inference-sim.git
45+
```
46+
47+
2. If you already have the repo cloned, ensure it’s up-to-date and your local branch is clean.
48+
49+
3. Release Branch Handling:
50+
- For a Release Candidate:
51+
Create a new release branch from the `main` branch. The branch should be named `release-${MAJOR}.${MINOR}`, for example, `release-0.1`:
52+
53+
```shell
54+
git checkout -b release-${MAJOR}.${MINOR}
55+
```
56+
57+
- For a Major, Minor or Patch Release:
58+
A release branch should already exist. In this case, check out the existing branch:
59+
60+
```shell
61+
git checkout -b release-${MAJOR}.${MINOR} ${REMOTE}/release-${MAJOR}.${MINOR}
62+
```
63+
64+
4. Update release-specific content, generate release artifacts, and stage the changes.
65+
66+
5. Sign, commit, and push the changes to the `llm-d-inference-sim` repo.
67+
68+
For a release candidate:
69+
70+
```shell
71+
git commit -s -m "Updates artifacts for v${MAJOR}.${MINOR}.${PATCH}-rc.${RC} release"
72+
```
73+
74+
For a major, minor or patch release:
75+
76+
```shell
77+
git commit -s -m "Updates artifacts for v${MAJOR}.${MINOR}.${PATCH} release"
78+
```
79+
80+
6. Push your release branch to the llm-d-inference-sim remote.
81+
82+
```shell
83+
git push ${REMOTE} release-${MAJOR}.${MINOR}
84+
```
85+
86+
7. Tag the head of your release branch with the number.
87+
88+
For a release candidate:
89+
90+
```shell
91+
git tag -s -a v${MAJOR}.${MINOR}.${PATCH}-rc.${RC} -m 'llm-d-inference-sim v${MAJOR}.${MINOR}.${PATCH}-rc.${RC} Release Candidate'
92+
```
93+
94+
For a major, minor or patch release:
95+
96+
```shell
97+
git tag -s -a v${MAJOR}.${MINOR}.${PATCH} -m 'llm-d-inference-sim v${MAJOR}.${MINOR}.${PATCH} Release'
98+
```
99+
100+
8. Push the tag to the llm-d-inference-sim repo.
101+
102+
For a release candidate:
103+
104+
```shell
105+
git push ${REMOTE} v${MAJOR}.${MINOR}.${PATCH}-rc.${RC}
106+
```
107+
108+
For a major, minor or patch release:
109+
110+
```shell
111+
git push ${REMOTE} v${MAJOR}.${MINOR}.${PATCH}
112+
```
113+
114+
9. Pushing the tag triggers CI action to build and publish the container image to the [ghcr registry].
115+
10. Test the steps in the tagged quickstart guide after the PR merges. TODO add e2e tests! <!-- link to an e2e tests once we have such one -->
116+
11. Create a [new release]:
117+
1. Choose the tag that you created for the release.
118+
2. Use the tag as the release title, i.e. `v0.1.0` refer to previous release for the content of the release body.
119+
3. Click "Generate release notes" and preview the release body.
120+
4. If this is a release candidate, select the "This is a pre-release" checkbox.
121+
12. If you find any bugs in this process, create an [issue].
122+
123+
## Announce the Release
124+
125+
Use the following steps to announce the release.
126+
127+
1. Send an announcement email to `[email protected]` with the subject:
128+
129+
```shell
130+
[ANNOUNCE] llm-d-inference-sim v${MAJOR}.${MINOR}.${PATCH} is released
131+
```
132+
133+
2. Add a link to the final release in this issue.
134+
135+
3. Close this issue.
136+
137+
[repo]: https://github.com/llm-d/llm-d-inference-sim
138+
[ghcr registry]: https://github.com/llm-d/llm-d-inference-sim/pkgs/container/llm-d-inference-sim
139+
[new release]: https://github.com/llm-d/llm-d-inference-sim/releases/new
140+
[issue]: https://github.com/llm-d/llm-d-inference-sim/issues/new/choose

0 commit comments

Comments
 (0)