diff --git a/.github/ISSUE_TEMPLATE/new-release.md b/.github/ISSUE_TEMPLATE/new-release.md index ab59b23b..efcaf0d2 100644 --- a/.github/ISSUE_TEMPLATE/new-release.md +++ b/.github/ISSUE_TEMPLATE/new-release.md @@ -13,34 +13,34 @@ Please do not remove items from the checklist --> - [ ] All [OWNERS](https://github.com/inftyai/llmaz/blob/main/OWNERS) must LGTM the release proposal - [ ] Verify that the changelog in this issue is up-to-date -- [ ] For major or minor releases (v$MAJ.$MIN.0), create a new release branch. - - [ ] an OWNER creates a vanilla release branch with - `git branch release-$MAJ.$MIN main` - - [ ] An OWNER pushes the new release branch with - `git push release-$MAJ.$MIN` -- [ ] Update things like README, deployment templates, docs, configuration, test/e2e flags. - Submit a PR against the release branch: +- [ ] Prepare the image and files + - [ ] Run `PLATFORMS=linux/amd64 make image-push GIT_TAG=$VERSION` to build and push an image. + - [ ] Run `make artifacts GIT_TAG=$VERSION` to generate the artifact. + - [ ] Run `make helm-package` to package the helm chart and update the index.yaml. +- [ ] Update `docs/installation.md`, `chart/README.md` + - [ ] Submit a PR and merge it. - [ ] An OWNER [prepares a draft release](https://github.com/inftyai/llmaz/releases) - - [ ] Write the change log into the draft release. - - [ ] Run - `make artifacts GIT_TAG=$VERSION` - to generate the artifacts and upload the files in the `artifacts` folder - to the draft release. -- [ ] An OWNER creates a signed tag running - `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). -- [ ] An OWNER pushes the tag with - `git push $VERSION` - - Publish a staging container image - make image-push GIT_TAG=$VERSION -- [ ] Publish the draft release prepared at the [Github releases page](https://github.com/inftyai/llmaz/releases). -- [ ] Add a link to the tagged release in this issue: -- [ ] For a major or minor release, update `README.md` and `docs/setup/install.md` - in `main` branch: + - [ ] Create a new tag + - [ ] Write the change log into the draft release + - [ ] Upload the files to the draft release. + - `manifests.yaml` under artifacts + - new generated helm chart `*.zip` file +- [ ] Publish the draft release prepared at the [Github releases page](https://github.com/inftyai/llmaz/releases) +- [ ] Publish the helm chart + - [ ] Run `git checkout gh-pages` + - [ ] Copy the `index.yaml` from main branch + - [ ] Submit a PR and merge it. - [ ] Close this issue ## Changelog + +🚀 **Major Features**: + +✨ **Features**: + +🐛 **Bugs**: + +♻️ **Cleanups**: \ No newline at end of file diff --git a/docs/installation.md b/docs/installation.md index f301eecb..6df6bf7a 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -12,7 +12,7 @@ ```cmd helm repo add inftyai https://inftyai.github.io/llmaz helm repo update -helm install llmaz inftyai/llmaz --namespace llmaz-system --create-namespace --version 0.0.2 +helm install llmaz inftyai/llmaz --namespace llmaz-system --create-namespace --version 0.0.3 ``` ### Uninstall