From c769f2566a2e62ff2ae9eaba4ba996c6d7485003 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E1=B4=9C=C9=B4=E1=B4=8B=C9=B4=E1=B4=A1=E1=B4=8F=C9=B4?= Date: Thu, 27 Aug 2020 15:33:46 +0800 Subject: [PATCH] docs: add patch release docs --- .../release/issue_template_minor_version.md | 4 +- .../release/issue_template_patch_release.md | 38 +++++++++++++++++++ docs/dev/release/release_new_version.md | 8 ++++ 3 files changed, 48 insertions(+), 2 deletions(-) create mode 100644 docs/dev/release/issue_template_patch_release.md diff --git a/docs/dev/release/issue_template_minor_version.md b/docs/dev/release/issue_template_minor_version.md index b7770d31e..b048711f2 100644 --- a/docs/dev/release/issue_template_minor_version.md +++ b/docs/dev/release/issue_template_minor_version.md @@ -14,15 +14,15 @@ On release branch: - [ ] Update the [hard-coded version](https://github.com/gogs/gogs/blob/master/gogs.go#L21) to the current release, e.g. `0.12.0+dev` -> `0.12.0`. - [ ] Publish a new [GitHub release](https://github.com/gogs/gogs/releases) with entries from [CHANGELOG](https://github.com/gogs/gogs/blob/master/CHANGELOG.md) for the current release. - [ ] Wait for a new [Docker Hub tag](https://hub.docker.com/r/gogs/gogs/tags) for the current release to be created automatically. +- [ ] Push another Docker image tag as `.`, e.g. `0.12`. - [ ] Compile and pack binaries (all prefixed with `gogs_.._`, e.g. `gogs_0.12.0_`): - [ ] macOS: `darwin_amd64.zip` - [ ] Linux: `linux_386.tar.gz`, `linux_386.zip`, `linux_amd64.tar.gz`, `linux_amd64.zip` - - [ ] ARM: `linux_armv7.zip` + - [ ] ARM: `linux_armv7.tar.gz`, `linux_armv7.zip` - [ ] Windows: `windows_amd64.zip`, `windows_amd64_mws.zip` - [ ] Generate SHA256 checksum for all binaries to the file `checksum_sha256.txt`. - [ ] Upload all binaries to: - [ ] GitHub release - - [ ] KeyCDN - [ ] https://dl.gogs.io (also upload `checksum_sha256.txt`) - [ ] Build, push and tag a new Docker image for ARM to [Docker Hub](https://hub.docker.com/r/gogs/gogs-rpi). diff --git a/docs/dev/release/issue_template_patch_release.md b/docs/dev/release/issue_template_patch_release.md new file mode 100644 index 000000000..a23266eec --- /dev/null +++ b/docs/dev/release/issue_template_patch_release.md @@ -0,0 +1,38 @@ +## Before release + +On develop branch: + +- [ ] Update [CHANGELOG](https://github.com/gogs/gogs/blob/master/CHANGELOG.md) to include entries for the current patch release. + +## During release + +On release branch: + +- [ ] Cherry-pick commits from develop branch: + - [ ] _link to the commit_ +- [ ] Wait for GitHub Actions to complete and no failed jobs. +- [ ] Update the [hard-coded version](https://github.com/gogs/gogs/blob/master/gogs.go#L21) to the current release, e.g. `0.12.0` -> `0.12.1`. +- [ ] Publish a new [GitHub release](https://github.com/gogs/gogs/releases) with entries from [CHANGELOG](https://github.com/gogs/gogs/blob/master/CHANGELOG.md) for the current patch release and all previous releases with same minor version. +- [ ] Update all previous GitHub releases with same minor version with the warning: + ``` + **ℹī¸ Heads up! There is a new patch release [0.12.1](https://github.com/gogs/gogs/releases/tag/v0.12.1) available, we recommend directly installing or upgrading to that version.** + ``` +- [ ] Wait for a new [Docker Hub tag](https://hub.docker.com/r/gogs/gogs/tags) for the current release to be created automatically. +- [ ] Update Docker image tag for the minor release `.`, e.g. `0.12`. +- [ ] Compile and pack binaries (all prefixed with `gogs_.._`, e.g. `gogs_0.12.0_`): + - [ ] macOS: `darwin_amd64.zip` + - [ ] Linux: `linux_386.tar.gz`, `linux_386.zip`, `linux_amd64.tar.gz`, `linux_amd64.zip` + - [ ] ARM: `linux_armv7.tar.gz`, `linux_armv7.zip` + - [ ] Windows: `windows_amd64.zip`, `windows_amd64_mws.zip` +- [ ] Generate SHA256 checksum for all binaries to the file `checksum_sha256.txt`. +- [ ] Upload all binaries to: + - [ ] GitHub release + - [ ] https://dl.gogs.io (also upload `checksum_sha256.txt`) +- [ ] Build, push and tag a new Docker image for ARM to [Docker Hub](https://hub.docker.com/r/gogs/gogs-rpi). + +## After release + +On develop branch: + +- [ ] Update the repository mirror on [Gitee](https://gitee.com/unknwon/gogs). +- [ ] Reply to the release topic for the minor release on [Gogs Discussion](https://discuss.gogs.io/c/announcements/5). diff --git a/docs/dev/release/release_new_version.md b/docs/dev/release/release_new_version.md index 4b3fbf514..0ec0d35ee 100644 --- a/docs/dev/release/release_new_version.md +++ b/docs/dev/release/release_new_version.md @@ -7,3 +7,11 @@ To release a new minor version, create a new GitHub issue with following attribu 1. Title: `Release ..0` 1. Label: [📸 release](https://github.com/gogs/gogs/labels/%F0%9F%93%B8%20release) 1. Content: [minor version issue template](issue_template_minor_version.md) + +## Make a patch release + +To make a patch release, create a new GitHub issue with following attributes: + +1. Title: `Release ..` +1. Label: [📸 release](https://github.com/gogs/gogs/labels/%F0%9F%93%B8%20release) +1. Content: [patch release issue template](issue_template_patch_release.md)