From f94042ce6faee50c08fc0c681109a62748b9cb0d Mon Sep 17 00:00:00 2001 From: Joe Chen Date: Sat, 31 Jan 2026 15:17:59 -0500 Subject: [PATCH] chore: update release templates [skip ci] --- .../dev_release_minor_version.md | 32 ++++++++----------- .../dev_release_patch_version.md | 15 +++------ CHANGELOG.md | 2 +- docker-next/README.md | 2 +- docker/README.md | 2 +- 5 files changed, 21 insertions(+), 32 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/dev_release_minor_version.md b/.github/ISSUE_TEMPLATE/dev_release_minor_version.md index 66ee1df62..945672134 100644 --- a/.github/ISSUE_TEMPLATE/dev_release_minor_version.md +++ b/.github/ISSUE_TEMPLATE/dev_release_minor_version.md @@ -15,29 +15,25 @@ 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). - [ ] [Update CHANGELOG](https://github.com/gogs/gogs/commit/f1102a7a7c545ec221d2906f02fa19170d96f96d) to include entries for the current minor release. -- [ ] Cut a new release branch `release/.`, e.g. `release/0.12`. + - Do not forget adding entries for GHSA patches. +- [ ] Cut a new release branch `release/.`, e.g. `release/0.14`. ## During release On the release branch: -- [ ] [Update the hard-coded version](https://github.com/gogs/gogs/commit/f17e7d5a2c36c52a1121d2315f3d75dcd8053b89) to the current release, e.g. `0.12.0+dev` -> `0.12.0`. +- [ ] [Update the hard-coded version](https://github.com/gogs/gogs/commit/f17e7d5a2c36c52a1121d2315f3d75dcd8053b89) to the current release, e.g. `0.14.0+dev` -> `0.14.0`. - [ ] Wait for GitHub Actions to complete and no failed jobs. -- [ ] Publish new RC releases (e.g. `v0.12.0-rc.1`, `v0.12.0-rc.2`) to ensure Docker workflow succeeds. **Make sure the tag is created on the release branch**. - - Pull down the Docker image and [run through application setup](https://github.com/gogs/gogs/blob/main/docker/README.md) to make sure nothing blows up. -- [ ] 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 minor release. **Make sure the tag is created on the release branch**. +- [ ] Publish new RC releases (e.g. `v0.14.0-rc.1`, `v0.14.0-rc.2`) to ensure Docker and release workflows both succeed. + - ⚠️ **Make sure the tag is created on the release branch**. + - [ ] Pull down the Docker image and [run through application setup](https://github.com/gogs/gogs/blob/main/docker/README.md) to make sure nothing blows up. + - [ ] Download one of the release archives and run through application setup to make sure nothing blows up. +- [ ] 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 minor release. + - ⚠️ **Make sure the tag is created on the release branch**. - [ ] [Wait for a new image tag for the current release](https://github.com/gogs/gogs/actions/workflows/docker.yml?query=event%3Arelease) 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 a new Docker image tag](https://github.com/gogs/gogs/blob/main/docs/dev/release/release_new_version.md#update-docker-image-tag) as `.` to both [Docker Hub](https://hub.docker.com/r/gogs/gogs/tags) and [GitHub Container registry](https://github.com/gogs/gogs/pkgs/container/gogs), e.g.: -- [ ] [Compile and pack binaries](https://github.com/gogs/gogs/blob/main/docs/dev/release/release_new_version.md#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](https://github.com/gogs/gogs/blob/main/docs/dev/release/sha256.sh) for all binaries to the file `checksum_sha256.txt`. -- [ ] Upload all binaries and `checksum_sha256.txt` to: - - [ ] GitHub release - - [ ] https://dl.gogs.io -- [ ] Update content of [Install from binary](https://gogs.io/docs/installation/install_from_binary). +- [ ] Download all release archives and [generate SHA256 checksum](https://github.com/gogs/gogs/blob/main/docs/dev/release/sha256.sh) for all binaries to the file `checksum_sha256.txt`. +- [ ] Upload all archives and `checksum_sha256.txt` to https://dl.gogs.io. ## After release @@ -47,7 +43,7 @@ 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 a tweet on the [official Twitter account](https://twitter.com/GogsHQ) for the minor release. -- [ ] Publish a new release article on [OSChina](http://my.oschina.net/Obahua/admin/releases). -- [ ] Close the minor milestone. -- [ ] [Bump the hard-coded version](https://github.com/gogs/gogs/commit/a98968436cd5841cf691bb0b80c54c81470d1676) to the new develop version, e.g. `0.12.0+dev` -> `0.13.0+dev`. +- [ ] Close the milestone for the minor release. +- [ ] [Bump the hard-coded version](https://github.com/gogs/gogs/commit/a98968436cd5841cf691bb0b80c54c81470d1676) to the new develop version, e.g. `0.14.0+dev` -> `0.15.0+dev`. - [ ] Run `task legacy` to identify deprecated code that is aimed to be removed in current develop version. +- [ ] **After 14 days**, publish [GitHub security advisories](https://github.com/gogs/gogs/security) for security patches included in the release. diff --git a/.github/ISSUE_TEMPLATE/dev_release_patch_version.md b/.github/ISSUE_TEMPLATE/dev_release_patch_version.md index 7341b8d53..aeac9bd67 100644 --- a/.github/ISSUE_TEMPLATE/dev_release_patch_version.md +++ b/.github/ISSUE_TEMPLATE/dev_release_patch_version.md @@ -25,6 +25,7 @@ On the release branch: - [ ] Publish new RC releases in [GitHub release](https://github.com/gogs/gogs/releases) (e.g. `v0.12.0-rc.1`, `v0.12.0-rc.2`) to ensure Docker workflow succeeds. - ⚠️ **Make sure the tag is created on the release branch**. - Pull down the Docker image and [run through application setup](https://github.com/gogs/gogs/blob/main/docker/README.md) to make sure nothing blows up. + - [ ] Download one of the release archives and run through application setup to make sure nothing blows up. - [ ] 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: @@ -34,16 +35,8 @@ On the release branch: - [ ] [Wait for a new image tag for the current release](https://github.com/gogs/gogs/actions/workflows/docker.yml?query=event%3Arelease) 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). - Pull down the Docker image and [run through application setup](https://github.com/gogs/gogs/blob/main/docker/README.md) to make sure nothing blows up. - [ ] [Update Docker image tag](https://www.notion.so/jcunknwon/Cheatsheet-and-playbooks-c3b053da42114411bd27285cd065b2a6?source=copy_link#1654f105c63f80958d96cd72e2f5df69) for the minor release `.` 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](https://www.notion.so/jcunknwon/Cheatsheet-and-playbooks-c3b053da42114411bd27285cd065b2a6?source=copy_link#1654f105c63f803f8bfcc117395d9747) (all prefixed with `gogs_.._`, e.g. `gogs_0.12.0_`): - - [ ] macOS: `darwin_arm64.zip`, `darwin_amd64.zip` - - [ ] Linux: `linux_amd64.tar.gz`, `linux_amd64.zip` - - [ ] ARM: `linux_armv8.tar.gz`, `linux_armv8.zip` - - [ ] Windows: `windows_amd64.zip`, `windows_amd64_mws.zip` -- [ ] [Generate SHA256 checksum](https://www.notion.so/jcunknwon/Cheatsheet-and-playbooks-c3b053da42114411bd27285cd065b2a6?source=copy_link#1654f105c63f80d4a74ad8821a403f52) for all binaries to the file `checksum_sha256.txt`. -- [ ] Upload all binaries and `checksum_sha256.txt` to: - - [ ] GitHub release - - [ ] https://dl.gogs.io -- [ ] Update content of [Install from binary](https://gogs.io/docs/installation/install_from_binary). +- [ ] Download all release archives and [generate SHA256 checksum](https://github.com/gogs/gogs/blob/main/docs/dev/release/sha256.sh) for all binaries to the file `checksum_sha256.txt`. +- [ ] Upload all archives and `checksum_sha256.txt` to https://dl.gogs.io. ## After release @@ -55,5 +48,5 @@ On the `main` branch: ``` - [ ] Create a new release announcement in [Discussions](https://github.com/gogs/gogs/discussions/categories/announcements). - [ ] Send a tweet on the [official Twitter account](https://twitter.com/GogsHQ) for the patch release. -- [ ] Close the patch milestone. +- [ ] Close the milestone for the patch release. - [ ] **After 14 days**, publish [GitHub security advisories](https://github.com/gogs/gogs/security) for security patches included in the release. diff --git a/CHANGELOG.md b/CHANGELOG.md index ca13088cc..e249e71a0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,7 +11,7 @@ All notable changes to Gogs are documented in this file. - Support using TLS for Redis session provider using `[session] PROVIDER_CONFIG = ...,tls=true`. [#7860](https://github.com/gogs/gogs/pull/7860) - Support expanading values in `app.ini` from environment variables, e.g. `[database] PASSWORD = ${DATABASE_PASSWORD}`. [#8057](https://github.com/gogs/gogs/pull/8057) - Support custom logout URL that users get redirected to after sign out using `[auth] CUSTOM_LOGOUT_URL`. [#8089](https://github.com/gogs/gogs/pull/8089) -- Start publishing next-generation, security-focused Docker image via `gogs/gogs:next-latest`, which will become the default image distribution (`gogs/gogs:latest`) starting 0.15.0. While not all container options support have been added in the next-generation image, the use of current legacy Docker image is deprecated, it will be published as `gogs/gogs:legacy-latest` starting 0.15.0, and be completely removed starting 0.16.0. [#8061](https://github.com/gogs/gogs/pull/8061) +- Start publishing next-generation, security-focused Docker image via `gogs/gogs:next-latest`, which will become the default image distribution (`gogs/gogs:latest`) starting 0.16.0. While not all container options support have been added in the next-generation image, the use of current legacy Docker image is deprecated, it will be published as `gogs/gogs:legacy-latest` starting 0.16.0, and be completely removed no earlier than 0.17.0. [#8061](https://github.com/gogs/gogs/pull/8061) ### Changed diff --git a/docker-next/README.md b/docker-next/README.md index 2d5f4d112..afec20858 100644 --- a/docker-next/README.md +++ b/docker-next/README.md @@ -1,7 +1,7 @@ # Docker for Gogs (Next Generation) > [!NOTE] -> This is the next-generation, security-focused Docker image. This will become the default image distribution (`gogs/gogs:latest`) starting 0.15.0. +> This is the next-generation, security-focused Docker image. This will become the default image distribution (`gogs/gogs:latest`) starting 0.16.0. ![Docker pulls](https://img.shields.io/docker/pulls/gogs/gogs?logo=docker&style=for-the-badge) diff --git a/docker/README.md b/docker/README.md index 13d57ad64..02a17fdd2 100644 --- a/docker/README.md +++ b/docker/README.md @@ -1,7 +1,7 @@ # Docker for Gogs > [!WARNING] -> This is now the legacy Docker image that lacks modern security best practices. It will be published as `gogs/gogs:legacy-latest` starting 0.15.0, and be completely removed starting 0.16.0. +> This is now the legacy Docker image that lacks modern security best practices. It will be published as `gogs/gogs:legacy-latest` starting 0.16.0, and be completely removed no earlier than 0.17.0. > > To use the next-generation, security-focused Docker image, see [docker-next/README.md](../docker-next/README.md).