diff options
author | Joe Chen <jc@unknwon.io> | 2022-01-16 18:51:17 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-01-16 18:51:17 +0800 |
commit | 74886d95d054092d1e9a64539910697ec9820aca (patch) | |
tree | ba0ab9bfb6ad924b819c283d00975ec7ede9004c | |
parent | acf2df368877ca619c0b91b9d07bc97c5a8834a6 (diff) |
docs: update release templates (#6728)
[skip ci]
-rw-r--r-- | .github/ISSUE_TEMPLATE/dev_release_minor_version.md (renamed from docs/dev/release/issue_template_minor_version.md) | 24 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/dev_release_patch_version.md (renamed from docs/dev/release/issue_template_patch_release.md) | 22 | ||||
-rw-r--r-- | docs/dev/release_new_version.md (renamed from docs/dev/release/release_new_version.md) | 8 |
3 files changed, 33 insertions, 21 deletions
diff --git a/docs/dev/release/issue_template_minor_version.md b/.github/ISSUE_TEMPLATE/dev_release_minor_version.md index 111db41a..020fd354 100644 --- a/docs/dev/release/issue_template_minor_version.md +++ b/.github/ISSUE_TEMPLATE/dev_release_minor_version.md @@ -1,6 +1,13 @@ +--- +name: Dev: Release a minor version +about: ONLY USED BY MAINTAINERS. +title: "Release [VERSION]" +labels: đ¸ release +--- + ## Before release -On develop branch: +On the `main` branch: - [ ] Close stale issues with the label [status: needs feedback](https://github.com/gogs/gogs/issues?q=is%3Aissue+is%3Aopen+label%3A%22status%3A+needs+feedback%22). - [ ] [Sync locales from Crowdin](https://github.com/gogs/gogs/blob/main/docs/dev/import_locale.md). @@ -9,30 +16,29 @@ On develop branch: ## During release -On release branch: +On the release branch: -- [ ] Update the [hard-coded version](https://github.com/gogs/gogs/blob/main/gogs.go#L21) to the current release, e.g. `0.12.0+dev` -> `0.12.0`. +- [ ] Update the [hard-coded version](https://github.com/gogs/gogs/blob/main/gogs.go#L22) 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/main/CHANGELOG.md) for the current release. - [ ] Wait for a new image tag for the current release to be created automatically on both [Docker Hub](https://hub.docker.com/r/gogs/gogs/tags) and [GitHub Container registry](https://github.com/gogs/gogs/pkgs/container/gogs). -- [ ] Push another Docker image tag as `<MAJOR>.<MINOR>`, e.g. `0.12`. +- [ ] Push another Docker image tag as `<MAJOR>.<MINOR>`, e.g. `0.12` to both [Docker Hub](https://hub.docker.com/r/gogs/gogs/tags) and [GitHub Container registry](https://github.com/gogs/gogs/pkgs/container/gogs). - [ ] Compile and pack binaries (all prefixed with `gogs_<MAJOR>.<MINOR>.<PATCH>_`, e.g. `gogs_0.12.0_`): - [ ] macOS: `darwin_amd64.zip`, `darwin_arm64.zip` - [ ] Linux: `linux_386.tar.gz`, `linux_386.zip`, `linux_amd64.tar.gz`, `linux_amd64.zip` - - [ ] ARM: `linux_armv7.tar.gz`, `linux_armv7.zip` + - [ ] ARM: `linux_armv7.tar.gz`, `linux_armv7.zip`, `linux_armv8.tar.gz`, `linux_armv8.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: +On the `main` branch: - [ ] Update the repository mirror on [Gitee](https://gitee.com/unknwon/gogs). - [ ] Create a new release announcement in [Discussions](https://github.com/gogs/gogs/discussions/categories/announcements). - [ ] Send out release announcement emails via [Mailchimp](https://mailchimp.com/). - [ ] Publish a new release article on [OSChina](http://my.oschina.net/Obahua/admin/releases). -- [ ] Update the [hard-coded version](https://github.com/gogs/gogs/blob/main/gogs.go#L21) to the new develop version, e.g. `0.12.0+dev` -> `0.13.0+dev`. -- [ ] Run `make legacy` to identify deprecated code that is aimed to be removed in current develop version. +- [ ] Bump the [hard-coded version](https://github.com/gogs/gogs/blob/main/gogs.go#L22) to the new develop version, e.g. `0.12.0+dev` -> `0.13.0+dev`. +- [ ] Run `task legacy` to identify deprecated code that is aimed to be removed in current develop version. diff --git a/docs/dev/release/issue_template_patch_release.md b/.github/ISSUE_TEMPLATE/dev_release_patch_version.md index 16989ffe..88b78a5c 100644 --- a/docs/dev/release/issue_template_patch_release.md +++ b/.github/ISSUE_TEMPLATE/dev_release_patch_version.md @@ -1,16 +1,23 @@ +--- +name: Dev: Release a patch version +about: ONLY USED BY MAINTAINERS. +title: "Release [VERSION]" +labels: đ¸ release +--- + ## Before release -On release branch: +On the release branch: -- [ ] Make sure all commits are cherry-picked from the develop branch by checking the patch milestone. +- [ ] Make sure all commits are cherry-picked from the `main` branch by checking the patch milestone. - [ ] Update [CHANGELOG](https://github.com/gogs/gogs/blob/main/CHANGELOG.md) to include entries for the current patch release, e.g. `git log v0.12.1...HEAD --pretty=format:'- [ ] %H %s' --reverse`: - [ ] _link to the commit_ ## During release -On release branch: +On the release branch: -- [ ] Update the [hard-coded version](https://github.com/gogs/gogs/blob/main/gogs.go#L21) to the current release, e.g. `0.12.0` -> `0.12.1`. +- [ ] Update the [hard-coded version](https://github.com/gogs/gogs/blob/main/gogs.go#L22) to the current release, e.g. `0.12.0` -> `0.12.1`. - [ ] Wait for GitHub Actions to complete and no failed jobs. - [ ] Publish a new [GitHub release](https://github.com/gogs/gogs/releases) with entries from [CHANGELOG](https://github.com/gogs/gogs/blob/main/CHANGELOG.md) for the current patch release and all previous releases with same minor version. **Make sure the tag is created on the release branch**. - [ ] Update all previous GitHub releases with same minor version with the warning: @@ -18,7 +25,7 @@ On release branch: **âšī¸ 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 image tag for the current release to be created automatically on both [Docker Hub](https://hub.docker.com/r/gogs/gogs/tags) and [GitHub Container registry](https://github.com/gogs/gogs/pkgs/container/gogs). -- [ ] Update Docker image tag for the minor release `<MAJOR>.<MINOR>`, e.g. `0.12`. +- [ ] Update Docker image tag for the minor release `<MAJOR>.<MINOR>`, e.g. `0.12` on both [Docker Hub](https://hub.docker.com/r/gogs/gogs/tags) and [GitHub Container registry](https://github.com/gogs/gogs/pkgs/container/gogs). - [ ] Compile and pack binaries (all prefixed with `gogs_<MAJOR>.<MINOR>.<PATCH>_`, e.g. `gogs_0.12.0_`): - [ ] macOS: `darwin_amd64.zip`, `darwin_arm64.zip` - [ ] Linux: `linux_386.tar.gz`, `linux_386.zip`, `linux_amd64.tar.gz`, `linux_amd64.zip` @@ -28,15 +35,14 @@ On release branch: - [ ] 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: +On the `main` branch: - [ ] Post the following message on issues that are included in the patch milestone: ``` - The <MAJOR>.<MINOR>.<PATCH> has been released. + The <MAJOR>.<MINOR>.<PATCH> has been released that includes the patch of the reported issue. ``` - [ ] Update the repository mirror on [Gitee](https://gitee.com/unknwon/gogs). - [ ] Reply to the release topic for the minor release in [Discussions](https://github.com/gogs/gogs/discussions/categories/announcements). diff --git a/docs/dev/release/release_new_version.md b/docs/dev/release_new_version.md index 0ec0d35e..aa9d0093 100644 --- a/docs/dev/release/release_new_version.md +++ b/docs/dev/release_new_version.md @@ -6,12 +6,12 @@ To release a new minor version, create a new GitHub issue with following attribu 1. Title: `Release <MAJOR>.<MINOR>.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) +1. Template: [Dev: Release a minor version](https://github.com/gogs/gogs/issues/new/choose) -## Make a patch release +## Release a patch version -To make a patch release, create a new GitHub issue with following attributes: +To release a new patch version, create a new GitHub issue with following attributes: 1. Title: `Release <MAJOR>.<MINOR>.<PATCH>` 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) +1. Template: [Dev: Release a patch version](https://github.com/gogs/gogs/issues/new/choose) |