From e337e8350699b2cf65e76bac97dd33b955a87094 Mon Sep 17 00:00:00 2001 From: ahg-g Date: Mon, 3 Feb 2025 06:20:43 +0000 Subject: [PATCH 1/3] Adding an artifacts make rule for release --- .gitignore | 1 + Makefile | 15 +++++++-------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index 3b1fa7ba..4442b651 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,7 @@ *.dylib bin/* Dockerfile.cross +artifacts # Test binary, built with `go test -c` *.test diff --git a/Makefile b/Makefile index 087dd69d..1dc6348b 100644 --- a/Makefile +++ b/Makefile @@ -195,14 +195,13 @@ install: manifests kustomize ## Install CRDs into the K8s cluster specified in ~ uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion. $(KUSTOMIZE) build config/crd | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f - -.PHONY: deploy -deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config. - cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG} - $(KUSTOMIZE) build config/default | $(KUBECTL) apply -f - - -.PHONY: undeploy -undeploy: kustomize ## Undeploy controller from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion. - $(KUSTOMIZE) build config/default | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f - +##@ Release +.PHONY: artifacts +artifacts: kustomize + if [ -d artifacts ]; then rm -rf artifacts; fi + mkdir -p artifacts + $(KUSTOMIZE) build config/crd -o artifacts/manifests.yaml + @$(call clean-manifests) ##@ Dependencies From b7a613a5da15e2e3f621c0745ac40a5ce636831a Mon Sep 17 00:00:00 2001 From: ahg-g Date: Mon, 3 Feb 2025 07:02:57 +0000 Subject: [PATCH 2/3] Added initial release instructions --- .github/ISSUE_TEMPLATE/bug_request.md | 27 +++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 15 ++++++++ .github/ISSUE_TEMPLATE/new-release.md | 46 +++++++++++++++++++++++ 3 files changed, 88 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/new-release.md diff --git a/.github/ISSUE_TEMPLATE/bug_request.md b/.github/ISSUE_TEMPLATE/bug_request.md new file mode 100644 index 00000000..123122a1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_request.md @@ -0,0 +1,27 @@ +--- +name: Bug Report +about: Report a bug encountered while using JobSet +labels: kind/bug + +--- + + + + +**What happened**: + +**What you expected to happen**: + +**How to reproduce it (as minimally and precisely as possible)**: + +**Anything else we need to know?**: + +**Environment**: +- Kubernetes version (use `kubectl version`): +- Inference extension version (use `git describe --tags --dirty --always`): +- Cloud provider or hardware configuration: +- Install tools: +- Others: diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..53a885c7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,15 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + + + +**What would you like to be added**: + +**Why is this needed**: + diff --git a/.github/ISSUE_TEMPLATE/new-release.md b/.github/ISSUE_TEMPLATE/new-release.md new file mode 100644 index 00000000..f3917e5c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-release.md @@ -0,0 +1,46 @@ +--- +name: New Release +about: Propose a new release +title: Release v0.x.0 +labels: '' +assignees: '' + +--- + +## Release Checklist +- [ ] For major or minor releases (v$MAJ.$MIN.0), create a new release branch. + - [ ] A maintainer creates a vanilla release branch with + `git branch release-$MAJ.$MIN main` + - [ ] A maintainer pushes the new release branch with + `git push release-$MAJ.$MIN` (e.g., release-0.1) +- [ ] Update things like README, deployment templates, docs, configuration, test/e2e flags. + Submit a PR against the release branch. +- [ ] A maintainer [prepares a draft release](https://github.com/kubernetes-sigs/gateway-api-inference-extension/releases) + - [ ] Write the change log into the draft release. + - [ ] Run + `make artifacts` + to generate the artifacts and upload the files in the `artifacts` folder to the draft release. +- [ ] A maintainer creates a signed tag running (e.g., VERSION=v0.1.0) + `git tag -s $VERSION` + and inserts the changelog into the tag description. + 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). +- [ ] A maintainer pushes the tag with + `git push $VERSION` + - Triggers prow to build and publish a staging container image + [`us-central1-docker.pkg.dev/k8s-staging-images/llm-instance-gateway/epp:$VERSION`](https://us-central1-docker.pkg.dev/k8s-staging-images/llm-instance-gateway/epp) +- [ ] Submit a PR against [k8s.io](https://github.com/kubernetes/k8s.io), + 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 + promote the container images from staging to production. +- [ ] Wait for the PR to be merged and verify that the image `registry.k8s.io/gateway-api-inference-extension/epp:$VERSION` is available. +- [ ] Publish the draft release prepared at the [Github releases page](https://github.com/kubernetes-sigs/gateway-api-inference-extension/releases). +- [ ] Add a link to the tagged release in this issue: +- [ ] Send an announcement email to `wg-serving@kubernetes.io` and `dev@kubernetes.io` with the subject `[ANNOUNCE] Gateway API Inference Extension $VERSION is released` +- [ ] Add a link to the release announcement in this issue: +- [ ] Update docs in `main` branch: +- [ ] Close this issue + + +## Changelog + From eea8bb5bab3b59274e678ac0c9d8f421a9e2e776 Mon Sep 17 00:00:00 2001 From: ahg-g Date: Mon, 3 Feb 2025 17:06:35 +0000 Subject: [PATCH 3/3] Addressed comments --- .github/ISSUE_TEMPLATE/bug_request.md | 3 +-- .github/ISSUE_TEMPLATE/new-release.md | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_request.md b/.github/ISSUE_TEMPLATE/bug_request.md index 123122a1..c2597eb3 100644 --- a/.github/ISSUE_TEMPLATE/bug_request.md +++ b/.github/ISSUE_TEMPLATE/bug_request.md @@ -1,6 +1,6 @@ --- name: Bug Report -about: Report a bug encountered while using JobSet +about: Report a bug you encountered labels: kind/bug --- @@ -10,7 +10,6 @@ labels: kind/bug If the matter is security related, please disclose it privately via https://kubernetes.io/security/ --> - **What happened**: **What you expected to happen**: diff --git a/.github/ISSUE_TEMPLATE/new-release.md b/.github/ISSUE_TEMPLATE/new-release.md index f3917e5c..2d2cafb4 100644 --- a/.github/ISSUE_TEMPLATE/new-release.md +++ b/.github/ISSUE_TEMPLATE/new-release.md @@ -13,7 +13,7 @@ assignees: '' `git branch release-$MAJ.$MIN main` - [ ] A maintainer pushes the new release branch with `git push release-$MAJ.$MIN` (e.g., release-0.1) -- [ ] Update things like README, deployment templates, docs, configuration, test/e2e flags. +- [ ] Update content and artifacts such as README, deployment templates, docs, configuration, test/e2e flags. Submit a PR against the release branch. - [ ] A maintainer [prepares a draft release](https://github.com/kubernetes-sigs/gateway-api-inference-extension/releases) - [ ] Write the change log into the draft release. @@ -39,7 +39,6 @@ assignees: '' - [ ] Update docs in `main` branch: - [ ] Close this issue - ## Changelog