From 74886d95d054092d1e9a64539910697ec9820aca Mon Sep 17 00:00:00 2001 From: Joe Chen Date: Sun, 16 Jan 2022 18:51:17 +0800 Subject: docs: update release templates (#6728) [skip ci] --- docs/dev/release/issue_template_minor_version.md | 38 --------------------- docs/dev/release/issue_template_patch_release.md | 43 ------------------------ docs/dev/release/release_new_version.md | 17 ---------- docs/dev/release_new_version.md | 17 ++++++++++ 4 files changed, 17 insertions(+), 98 deletions(-) delete mode 100644 docs/dev/release/issue_template_minor_version.md delete mode 100644 docs/dev/release/issue_template_patch_release.md delete mode 100644 docs/dev/release/release_new_version.md create mode 100644 docs/dev/release_new_version.md (limited to 'docs') diff --git a/docs/dev/release/issue_template_minor_version.md b/docs/dev/release/issue_template_minor_version.md deleted file mode 100644 index 111db41a..00000000 --- a/docs/dev/release/issue_template_minor_version.md +++ /dev/null @@ -1,38 +0,0 @@ -## Before release - -On develop 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). -- [ ] Update [CHANGELOG](https://github.com/gogs/gogs/blob/main/CHANGELOG.md) to include entries for the current release. -- [ ] Cut a new release branch `release/.`, e.g. `release/0.12`. - -## During release - -On 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`. -- [ ] 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 `.`, e.g. `0.12`. -- [ ] Compile and pack binaries (all prefixed with `gogs_.._`, 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` - - [ ] 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). -- [ ] 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. diff --git a/docs/dev/release/issue_template_patch_release.md b/docs/dev/release/issue_template_patch_release.md deleted file mode 100644 index 16989ffe..00000000 --- a/docs/dev/release/issue_template_patch_release.md +++ /dev/null @@ -1,43 +0,0 @@ -## Before release - -On release branch: - -- [ ] Make sure all commits are cherry-picked from the develop 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: - -- [ ] 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`. -- [ ] 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: - ``` - **ℹī¸ 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 `.`, e.g. `0.12`. -- [ ] Compile and pack binaries (all prefixed with `gogs_.._`, 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`, `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: - -- [ ] Post the following message on issues that are included in the patch milestone: - ``` - The .. has been released. - ``` -- [ ] 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). -- [ ] Close the patch milestone. diff --git a/docs/dev/release/release_new_version.md b/docs/dev/release/release_new_version.md deleted file mode 100644 index 0ec0d35e..00000000 --- a/docs/dev/release/release_new_version.md +++ /dev/null @@ -1,17 +0,0 @@ -# Release a new version - -## Release a minor version - -To release a new minor version, create a new GitHub issue with following attributes: - -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) diff --git a/docs/dev/release_new_version.md b/docs/dev/release_new_version.md new file mode 100644 index 00000000..aa9d0093 --- /dev/null +++ b/docs/dev/release_new_version.md @@ -0,0 +1,17 @@ +# Release a new version + +## Release a minor version + +To release a new minor version, create a new GitHub issue with following attributes: + +1. Title: `Release ..0` +1. Label: [📸 release](https://github.com/gogs/gogs/labels/%F0%9F%93%B8%20release) +1. Template: [Dev: Release a minor version](https://github.com/gogs/gogs/issues/new/choose) + +## Release a patch version + +To release a new patch version, 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. Template: [Dev: Release a patch version](https://github.com/gogs/gogs/issues/new/choose) -- cgit v1.2.3