From 079e7dfcc8b6648df247dc2284a070dea9417533 Mon Sep 17 00:00:00 2001 From: Kim Tsao <84398375+kim-tsao@users.noreply.github.com> Date: Mon, 24 Apr 2023 16:13:25 -0400 Subject: [PATCH] Update release doc (#1110) Signed-off-by: Kim Tsao --- docs/proposals/versioning-and-release.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/proposals/versioning-and-release.md b/docs/proposals/versioning-and-release.md index 137fd0436..24f668b21 100644 --- a/docs/proposals/versioning-and-release.md +++ b/docs/proposals/versioning-and-release.md @@ -85,12 +85,21 @@ The following steps outline the steps done to release a new version of the Devfi 7) Make a release announcement on the devfile mailing list and slack channel An example pull request, `make-release.sh` script and GitHub action can be found here: -- [Release Pull Request](https://github.com/johnmcollier/api/pull/7) -- [make-release.sh](https://github.com/johnmcollier/api/blob/master/make-release.sh) -- [release-schema.yaml](https://github.com/johnmcollier/api/blob/master/.github/workflows/release-schema.yaml) +- [Release Pull Request](https://github.com/devfile/api/pull/958) +- [make-release.sh](./make-release.sh) +- [release-schema.yaml](./.github/workflows/release-devfile-schema.yaml) **Schema Store** After releasing a new version, for example 2.2.0, we will also need to update the schemastore's [catalog.json](https://github.com/SchemaStore/schemastore/blob/master/src/api/json/catalog.json#L1119-L1132). Open a PR to update the devfile entry to include the new devfile version and also update the default url to the latest version. + +## Post Release + +Create a pre-release tag pointing to the first commit hash following a published release. In addition to preparing for the next release, this will also allow devfile clients to update their dependencies without the unintended side effects of version downgrading. See [api issue 559](https://github.com/devfile/api/issues/599) for the background discussion. + +1) Create a new release tag following the [Github instructions](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) +2) Sync the pre-release tag name to the version found in the [latest schemas](https://github.com/devfile/api/blob/main/schemas/latest/devfile.json#L4) e.g. `{major}.{minor}.{bugfix}-alpha` +3) Select the option `Set as a pre-release` before publishing +