Skip to content

Commit 233c73b

Browse files
committed
Added initial release instructions
1 parent e337e83 commit 233c73b

File tree

3 files changed

+88
-0
lines changed

3 files changed

+88
-0
lines changed

.github/ISSUE_TEMPLATE/bug_request.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug encountered while using JobSet
4+
labels: kind/bug
5+
6+
---
7+
8+
<!-- 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!
9+
10+
If the matter is security related, please disclose it privately via https://kubernetes.io/security/
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+
- Inference extension version (use `git describe --tags --dirty --always`):
25+
- Cloud provider or hardware configuration:
26+
- Install tools:
27+
- Others:
+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
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**:
15+

.github/ISSUE_TEMPLATE/new-release.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
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+
## Release Checklist
11+
- [ ] For major or minor releases (v$MAJ.$MIN.0), create a new release branch.
12+
- [ ] A maintainer creates a vanilla release branch with
13+
`git branch release-$MAJ.$MIN main`
14+
- [ ] A maintainer pushes the new release branch with
15+
`git push release-$MAJ.$MIN` (e.g., release-0.1)
16+
- [ ] Update things like README, deployment templates, docs, configuration, test/e2e flags.
17+
Submit a PR against the release branch.
18+
- [ ] A maintainer [prepares a draft release](https://github.com/kubernetes-sigs/gateway-api-inference-extension/releases)
19+
- [ ] Write the change log into the draft release.
20+
- [ ] Run
21+
`make artifacts`
22+
to generate the artifacts and upload the files in the `artifacts` folder to the draft release.
23+
- [ ] A maintainer creates a signed tag running (e.g., VERSION=v0.1.0)
24+
`git tag -s $VERSION`
25+
and inserts the changelog into the tag description.
26+
To perform this step, you need [a PGP key registered on github](https://docs.github.com/en/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys).
27+
- [ ] A maintainer pushes the tag with
28+
`git push $VERSION`
29+
- Triggers prow to build and publish a staging container image
30+
[`https://pantheon.corp.google.com/artifacts/docker/k8s-staging-images/us-central1/llm-instance-gateway/epp:$VERSION`](https://us-central1-docker.pkg.dev/k8s-staging-images/llm-instance-gateway/epp)
31+
- [ ] Submit a PR against [k8s.io](https://github.com/kubernetes/k8s.io),
32+
updating [`k8s-staging-gateway-api-inference-extension/images.yaml`](https://github.com/kubernetes/k8s.io/blob/main/registry.k8s.io/images/k8s-staging-gateway-api-inference-extension/images.yaml) to
33+
promote the container images from staging to production: <!-- link to example PR once we have one -->
34+
- [ ] Wait for the PR to be merged and verify that the image `registry.k8s.io/gateway-api-inference-extension/epp:$VERSION` is available.
35+
- [ ] Publish the draft release prepared at the [Github releases page](https://github.com/kubernetes-sigs/gateway-api-inference-extension/releases).
36+
- [ ] Add a link to the tagged release in this issue: <!-- example https://github.com/kubernetes-sigs/gateway-api-inference-extension/releases/tag/v0.1.0 -->
37+
- [ ] Send an announcement email to `[email protected]` and `[email protected]` with the subject `[ANNOUNCE] Gateway API Inference Extension $VERSION is released`
38+
- [ ] Add a link to the release announcement in this issue: <!-- link to an example email once we have one -->
39+
- [ ] Update docs in `main` branch: <!-- link to example PR once we have one -->
40+
- [ ] Close this issue
41+
42+
43+
## Changelog
44+
<!--
45+
Describe changes since the last release here.
46+
-->

0 commit comments

Comments
 (0)