From 127eff49ee76aba5f78d1f356fb85d2d78825fb2 Mon Sep 17 00:00:00 2001 From: Earl Warren Date: Fri, 26 Apr 2024 08:26:33 +0000 Subject: [PATCH] docs(release-notes): split items in files to avoid conflicts (#3452) I thought there would be conflicts but that they would not be so difficult to manage. Worst idea I had this week. Change to @oliverpool idea instead. > Instead of documenting the release notes in the issue, why not in the codebase? > > For instance in [go](https://cs.opensource.google/go/go/+/master:doc/README.md) there is a `doc/next` folder where you add `.md` files which document each pr. > > Before the release, a script takes all those files to generate the changelog. > > Having them as a file tracked by git, makes them easy to review and to programmatically handle. Refs: https://codeberg.org/forgejo/discussions/issues/155#issuecomment-1787013 Co-authored-by: Shiny Nematoda Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/3452 Reviewed-by: Gergely Nagy Co-authored-by: Earl Warren Co-committed-by: Earl Warren --- RELEASE-NOTES.md | 25 ++----------------------- release-notes/8.0.0/fix/3399.md | 1 + release-notes/8.0.0/fix/3430.md | 1 + release-notes/8.0.0/fix/3442.md | 1 + release-notes/8.0.0/fix/3444.md | 1 + release-notes/8.0.0/fix/3451.md | 1 + 6 files changed, 7 insertions(+), 23 deletions(-) create mode 100644 release-notes/8.0.0/fix/3399.md create mode 100644 release-notes/8.0.0/fix/3430.md create mode 100644 release-notes/8.0.0/fix/3442.md create mode 100644 release-notes/8.0.0/fix/3444.md create mode 100644 release-notes/8.0.0/fix/3451.md diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md index 10bad6e916..85c8f8bcc1 100644 --- a/RELEASE-NOTES.md +++ b/RELEASE-NOTES.md @@ -4,30 +4,9 @@ A minor or major Forgejo release is published every [three months](https://forge A [patch or minor release](https://semver.org/spec/v2.0.0.html) (e.g. upgrading from v7.0.0 to v7.0.1 or v7.1.0) does not require manual intervention. But [major releases](https://semver.org/spec/v2.0.0.html#spec-item-8) where the first version number changes (e.g. upgrading from v1.21 to v7.0) contain breaking changes and the release notes explain how to deal with them. -## 8.0.0 +## Upcoming releases (not available yet) -This is a major release. It contains breaking changes that may require manual intervention. See the documentation for more information on the [upgrade procedure](https://forgejo.org/docs/v7.0/admin/upgrade/). - -* **Breaking changes:** - -In addition to the following notable bug fixes, you can browse the [full list of commits](https://codeberg.org/forgejo/forgejo/compare/v8.0.0...v7.0.0) included in this release. - -If you have any feedback or suggestions for Forgejo do not hold back, it is also your project. -Open an issue in [the issue tracker](https://codeberg.org/forgejo/forgejo/issues) -for feature requests or bug reports, reach out [on the Fediverse](https://floss.social/@forgejo), -or drop into [the Matrix space](https://matrix.to/#/#forgejo:matrix.org) -([main chat room](https://matrix.to/#/#forgejo-chat:matrix.org)) and say hi! - -## 7.0.1 - -This is a bug fix release. See the documentation for more information on the [upgrade procedure](https://forgejo.org/docs/v7.0/admin/upgrade/). - -In addition to the following notable bug fixes, you can browse the [full list of commits](https://codeberg.org/forgejo/forgejo/compare/v7.0.0...v7.0.1) included in this release. - -* **Bug fixes:** - * The regression in the [`fogejo admin user create`](https://forgejo.org/docs/v7.0/admin/command-line/#admin-user-create) CLI command [is fixed](https://codeberg.org/forgejo/forgejo/issues/3399) and it is backward compatible. - * Fixed a bug where the `/api/v1/repos/{owner}/{repo}/wiki` API endpoints were using a hardcoded "master" branch for the wiki, rather than the branch they really use. ([#3430](https://codeberg.org/forgejo/forgejo/pulls/3430)) - * Fixed an error 500 when visiting [the LFS settings]() at `/{owner}/{repo}/settings/lfs/find?oid=...`. +- [8.0.0](/release-notes/8.0.0/) ## 7.0.0 diff --git a/release-notes/8.0.0/fix/3399.md b/release-notes/8.0.0/fix/3399.md new file mode 100644 index 0000000000..d25d66d5f0 --- /dev/null +++ b/release-notes/8.0.0/fix/3399.md @@ -0,0 +1 @@ +The regression in the [`fogejo admin user create`](https://forgejo.org/docs/v7.0/admin/command-line/#admin-user-create) CLI command [is fixed](https://codeberg.org/forgejo/forgejo/issues/3399) and it is backward compatible. diff --git a/release-notes/8.0.0/fix/3430.md b/release-notes/8.0.0/fix/3430.md new file mode 100644 index 0000000000..17d91653e9 --- /dev/null +++ b/release-notes/8.0.0/fix/3430.md @@ -0,0 +1 @@ +Fixed a bug where the `/api/v1/repos/{owner}/{repo}/wiki` API endpoints were using a hardcoded "master" branch for the wiki, rather than the branch they really use. diff --git a/release-notes/8.0.0/fix/3442.md b/release-notes/8.0.0/fix/3442.md new file mode 100644 index 0000000000..7c4feafb68 --- /dev/null +++ b/release-notes/8.0.0/fix/3442.md @@ -0,0 +1 @@ +Save updated empty comments instead of skipping the update silently, [which prevented the removal of attachments of such comments](https://codeberg.org/forgejo/forgejo/issues/3424). diff --git a/release-notes/8.0.0/fix/3444.md b/release-notes/8.0.0/fix/3444.md new file mode 100644 index 0000000000..4988fdad15 --- /dev/null +++ b/release-notes/8.0.0/fix/3444.md @@ -0,0 +1 @@ +Fixed bleve indexer failing when [fuzziness exceeds the maximum 2](https://codeberg.org/forgejo/forgejo/pulls/3444) diff --git a/release-notes/8.0.0/fix/3451.md b/release-notes/8.0.0/fix/3451.md new file mode 100644 index 0000000000..e0c307e896 --- /dev/null +++ b/release-notes/8.0.0/fix/3451.md @@ -0,0 +1 @@ +Fixed an error 500 when visiting [the LFS settings](https://codeberg.org/forgejo/forgejo/pulls/3451) at `/{owner}/{repo}/settings/lfs/find?oid=...`.