Skip to content

Commit 079e7df

Browse files
authored
Update release doc (#1110)
Signed-off-by: Kim Tsao <[email protected]>
1 parent a6c32fc commit 079e7df

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

docs/proposals/versioning-and-release.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,12 +85,21 @@ The following steps outline the steps done to release a new version of the Devfi
8585
7) Make a release announcement on the devfile mailing list and slack channel
8686

8787
An example pull request, `make-release.sh` script and GitHub action can be found here:
88-
- [Release Pull Request](https://github.com/johnmcollier/api/pull/7)
89-
- [make-release.sh](https://github.com/johnmcollier/api/blob/master/make-release.sh)
90-
- [release-schema.yaml](https://github.com/johnmcollier/api/blob/master/.github/workflows/release-schema.yaml)
88+
- [Release Pull Request](https://github.com/devfile/api/pull/958)
89+
- [make-release.sh](./make-release.sh)
90+
- [release-schema.yaml](./.github/workflows/release-devfile-schema.yaml)
9191

9292
**Schema Store**
9393

9494
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).
9595

9696
Open a PR to update the devfile entry to include the new devfile version and also update the default url to the latest version.
97+
98+
## Post Release
99+
100+
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.
101+
102+
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)
103+
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`
104+
3) Select the option `Set as a pre-release` before publishing
105+

0 commit comments

Comments
 (0)