Skip to content

Commit

Permalink
Re-organize the releasenotes directory into changelog (vitessio#1…
Browse files Browse the repository at this point in the history
…2566)

* Move all release related documents to ./release and add tool to generate READMEs

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* Addition of the release.go file

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* simplify release.go

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* generate the release notes in the proper place

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* modify previous mentions of docs/releasenotes

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* re-add v17.0.0 summary

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* add new release tool to release instruction and ci

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* apply review suggestions

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* simplify release notes document path

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

* Apply review suggestions and fix team files

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

---------

Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
  • Loading branch information
frouioui committed Mar 20, 2023
1 parent 2b43fd7 commit b396055
Show file tree
Hide file tree
Showing 96 changed files with 362 additions and 29 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/check_label.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
- name: Release Notes label
run: |
if [[ "${{contains( github.event.pull_request.labels.*.name, 'release notes (needs details)')}}" == "true" ]]; then
echo The "release notes (needs details)" label is set. The changes made in this Pull Request need to be documented in the release notes summary "('./doc/releasenotes/16_0_0_summary.md')". Once documented, the "release notes (needs details)" label can be removed.
echo The "release notes (needs details)" label is set. The changes made in this Pull Request need to be documented in the release notes summary "('./changelog/17.0/17.0.0/summary.md')". Once documented, the "release notes (needs details)" label can be removed.
exit 1
fi
Expand Down
17 changes: 17 additions & 0 deletions .github/workflows/static_checks_etc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,9 @@ jobs:
ci_config:
- 'test/config.json'
- '.github/workflows/static_checks_etc.yml'
release_notes:
- 'changelog/**'
- './go/tools/releases/**'
- name: Set up Go
if: steps.skip-workflow.outputs.skip-workflow == 'false' && (steps.changes.outputs.go_files == 'true' || steps.changes.outputs.parser_changes == 'true' || steps.changes.outputs.proto_changes == 'true')
Expand Down Expand Up @@ -206,3 +209,17 @@ jobs:
if: steps.skip-workflow.outputs.skip-workflow == 'false' && (steps.changes.outputs.go_files == 'true' || steps.changes.outputs.ci_config == 'true')
run: |
go run ./go/tools/ci-config/main.go || exit 1
- name: Check changelog
if: steps.skip-workflow.outputs.skip-workflow == 'false' && steps.changes.outputs.release_notes == 'true'
run: |
set -e
go run ./go/tools/releases/releases.go
output=$(git status -s)
if [ -z "${output}" ]; then
exit 0
fi
echo 'We wish to maintain a consistent changelog directory, please run `go run ./go/tools/releases/releases.go`, commit and push again.'
echo 'Running `go run ./go/tools/releases/releases.go` on CI yields the following changes:'
echo "$output"
echo ""
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ _test/
/vendor/*/

# release folder
releases
/releases/

# Local examples
/examples/local/vtdataroot
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
18 changes: 18 additions & 0 deletions changelog/10.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## v10.0
* **[10.0.5](10.0.5)**
* [Release Notes](10.0.5/release_notes.md)

* **[10.0.4](10.0.4)**
* [Release Notes](10.0.4/release_notes.md)

* **[10.0.3](10.0.3)**
* [Release Notes](10.0.3/release_notes.md)

* **[10.0.2](10.0.2)**
* [Release Notes](10.0.2/release_notes.md)

* **[10.0.1](10.0.1)**
* [Release Notes](10.0.1/release_notes.md)

* **[10.0.0](10.0.0)**
* [Release Notes](10.0.0/release_notes.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
15 changes: 15 additions & 0 deletions changelog/11.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## v11.0
* **[11.0.4](11.0.4)**
* [Release Notes](11.0.4/release_notes.md)

* **[11.0.3](11.0.3)**
* [Release Notes](11.0.3/release_notes.md)

* **[11.0.2](11.0.2)**
* [Release Notes](11.0.2/release_notes.md)

* **[11.0.1](11.0.1)**
* [Release Notes](11.0.1/release_notes.md)

* **[11.0.0](11.0.0)**
* [Release Notes](11.0.0/release_notes.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Below is a summary of this patch release. You can learn more [here](https://go.d

> go1.17.12 (released 2022-07-12) includes security fixes to the compress/gzip, encoding/gob, encoding/xml, go/parser, io/fs, net/http, and path/filepath packages, as well as bug fixes to the compiler, the go command, the runtime, and the runtime/metrics package. [See the Go 1.17.12 milestone](https://github.com/golang/go/issues?q=milestone%3AGo1.17.12+label%3ACherryPickApproved) on our issue tracker for details.
------------
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/doc/releasenotes/12_0_5_changelog.md).
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/changelog/12.0/12.0.5/changelog.md).

The release includes 7 commits (excluding merges)

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This change is documented on our website [here](https://vitess.io/docs/12.0/over


------------
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/doc/releasenotes/12_0_6_changelog.md).
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/changelog/12.0/12.0.6/changelog.md).

The release includes 11 commits (excluding merges)

Expand Down
File renamed without changes.
23 changes: 23 additions & 0 deletions changelog/12.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## v12.0
* **[12.0.6](12.0.6)**
* [Changelog](12.0.6/changelog.md)
* [Release Notes](12.0.6/release_notes.md)

* **[12.0.5](12.0.5)**
* [Changelog](12.0.5/changelog.md)
* [Release Notes](12.0.5/release_notes.md)

* **[12.0.4](12.0.4)**
* [Release Notes](12.0.4/release_notes.md)

* **[12.0.3](12.0.3)**
* [Release Notes](12.0.3/release_notes.md)

* **[12.0.2](12.0.2)**
* [Release Notes](12.0.2/release_notes.md)

* **[12.0.1](12.0.1)**
* [Release Notes](12.0.1/release_notes.md)

* **[12.0.0](12.0.0)**
* [Release Notes](12.0.0/release_notes.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Below is a summary of this patch release. You can learn more [here](https://go.d

> go1.17.12 (released 2022-07-12) includes security fixes to the compress/gzip, encoding/gob, encoding/xml, go/parser, io/fs, net/http, and path/filepath packages, as well as bug fixes to the compiler, the go command, the runtime, and the runtime/metrics package. [See the Go 1.17.12 milestone](https://github.com/golang/go/issues?q=milestone%3AGo1.17.12+label%3ACherryPickApproved) on our issue tracker for details.
------------
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/doc/releasenotes/13_0_2_changelog.md).
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/changelog/13.0/13.0.2/changelog.md).
The release includes 28 commits (excluding merges)

Thanks to all our contributors: @GuptaManan100, @aquarapid, @frouioui, @harshit-gangal, @mattlord, @rohit-nayak-ps, @systay, @vitess-bot[bot], @vmg
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This change is documented on our website [here](https://vitess.io/docs/13.0/over


------------
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/doc/releasenotes/13_0_3_changelog.md).
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/changelog/13.0/13.0.3/changelog.md).

The release includes 17 commits(excluding merges)

Expand Down
File renamed without changes.
14 changes: 14 additions & 0 deletions changelog/13.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## v13.0
* **[13.0.3](13.0.3)**
* [Changelog](13.0.3/changelog.md)
* [Release Notes](13.0.3/release_notes.md)

* **[13.0.2](13.0.2)**
* [Changelog](13.0.2/changelog.md)
* [Release Notes](13.0.2/release_notes.md)

* **[13.0.1](13.0.1)**
* [Release Notes](13.0.1/release_notes.md)

* **[13.0.0](13.0.0)**
* [Release Notes](13.0.0/release_notes.md)
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ Work has gone into making the advisory locks (`get_lock()`, `release_lock()`, et
A long time ago, the sharding column and type were specified at the keyspace level. This syntax is now deprecated and will be removed in v15.

------------
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/doc/releasenotes/14_0_0_changelog.md).
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/changelog/14.0/14.0.0/changelog.md).

The release includes 1101 commits (excluding merges)

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Below is a summary of this patch release. You can learn more [here](https://go.d

> go1.18.4 (released 2022-07-12) includes security fixes to the compress/gzip, encoding/gob, encoding/xml, go/parser, io/fs, net/http, and path/filepath packages, as well as bug fixes to the compiler, the go command, the linker, the runtime, and the runtime/metrics package. [See the Go 1.18.4 milestone](https://github.com/golang/go/issues?q=milestone%3AGo1.18.4+label%3ACherryPickApproved) on our issue tracker for details.
------------
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/doc/releasenotes/14_0_1_changelog.md).
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/changelog/14.0/14.0.1/changelog.md).

The release includes 25 commits (excluding merges)

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Since the end-of-life of MariaDB 10.2, its Docker image is unavailable, and we d
You can find more information on the list of supported databases on our documentation website, [here](https://vitess.io/docs/14.0/overview/supported-databases/).

------------
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/doc/releasenotes/14_0_2_changelog.md).
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/changelog/14.0/14.0.2/changelog.md).

The release includes 23 commits (excluding merges)

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This problem could be resolved by restarting the VTOrc so that it discovers all
frequently, this posed a greater challenge, since some pods when evicted and rescheduled on a different node, would sometimes fail to be discovered by VTOrc.
This has problem has been addressed in this patch by the fix https://github.com/vitessio/vitess/pull/10662.
------------
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/doc/releasenotes/14_0_3_changelog.md).
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/changelog/14.0/14.0.3/changelog.md).

The release includes 12 commits (excluding merges)

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Below is a summary of this patch release. You can learn more [here](https://go.d
An issue in versions `<= v14.0.3` and `<= v15.0.0` that generated corrupted results for non-full-group-by queries with a JOIN
is now fixed. The full issue can be found [here](https://github.com/vitessio/vitess/issues/11625), and its fix [here](https://github.com/vitessio/vitess/pull/11633).
------------
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/doc/releasenotes/14_0_4_changelog.md).
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/changelog/14.0/14.0.4/changelog.md).

The release includes 24 commits (excluding merges)

Expand Down
File renamed without changes.
20 changes: 20 additions & 0 deletions changelog/14.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## v14.0
* **[14.0.4](14.0.4)**
* [Changelog](14.0.4/changelog.md)
* [Release Notes](14.0.4/release_notes.md)

* **[14.0.3](14.0.3)**
* [Changelog](14.0.3/changelog.md)
* [Release Notes](14.0.3/release_notes.md)

* **[14.0.2](14.0.2)**
* [Changelog](14.0.2/changelog.md)
* [Release Notes](14.0.2/release_notes.md)

* **[14.0.1](14.0.1)**
* [Changelog](14.0.1/changelog.md)
* [Release Notes](14.0.1/release_notes.md)

* **[14.0.0](14.0.0)**
* [Changelog](14.0.0/changelog.md)
* [Release Notes](14.0.0/release_notes.md)
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,7 @@ Below are the changes for each binary.
- [zkctld](https://github.com/vitessio/vitess/blob/release-15.0/doc/flags/14.0-to-15.0-transition/zkctld.diff)

------------
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/doc/releasenotes/15_0_0_changelog.md).
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/changelog/15.0/15.0.0/changelog.md).

The release includes 595 commits (excluding merges)

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This issue is fixed in 15.0.1. The full issue can be found [here](https://github

------------

The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/doc/releasenotes/15_0_1_changelog.md).
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/changelog/15.0/15.0.1/changelog.md).

The release includes 25 commits (excluding merges)

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Below is a summary of this patch release. You can learn more [here](https://grou

------------

The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/doc/releasenotes/15_0_2_changelog.md).
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/changelog/15.0/15.0.2/changelog.md).

The release includes 14 commits (excluding merges)

Expand Down
File renamed without changes.
13 changes: 13 additions & 0 deletions changelog/15.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## v15.0
The dedicated team for this release can be found [here](team.md).
* **[15.0.2](15.0.2)**
* [Changelog](15.0.2/changelog.md)
* [Release Notes](15.0.2/release_notes.md)

* **[15.0.1](15.0.1)**
* [Changelog](15.0.1/changelog.md)
* [Release Notes](15.0.1/release_notes.md)

* **[15.0.0](15.0.0)**
* [Changelog](15.0.0/changelog.md)
* [Release Notes](15.0.0/release_notes.md)
5 changes: 5 additions & 0 deletions changelog/15.0/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## Release Team for v15

- **Lead:** Rameez Sajwani ([rsajwani](https://github.com/rsajwani)) rameez@planetscale.com
- **Shadow:** Manan Gupta ([GuptaManan100](https://github.com/GuptaManan100)) manan@planetscale.com
- **Mentor:** Florent Poinsard ([frouioui](https://github.com/frouioui)) florent@planetscale.com
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -525,7 +525,7 @@ The sidecar tables `local_metadata` and `shard_metadata` are no longer in use an
part of this refactor. They were used previously for Orchestrator support, which has been superseded by `vtorc`.

------------
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/doc/releasenotes/16_0_0_changelog.md).
The entire changelog for this release can be found [here](https://github.com/vitessio/vitess/blob/main/changelog/16.0/16.0.0/changelog.md).

The release includes 378 commits (excluding merges)

Expand Down
File renamed without changes.
5 changes: 5 additions & 0 deletions changelog/16.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## v16.0
The dedicated team for this release can be found [here](team.md).
* **[16.0.0](16.0.0)**
* [Changelog](16.0.0/changelog.md)
* [Release Notes](16.0.0/release_notes.md)
5 changes: 5 additions & 0 deletions changelog/16.0/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## Release Team for v16

- **Lead:** Manan Gupta ([GuptaManan100](https://github.com/GuptaManan100)) manan@planetscale.com
- **Shadow:** Matt Lord ([mattlord](https://github.com/mattlord)) mlord@planetscale.com
- **Mentor:** Florent Poinsard ([frouioui](https://github.com/frouioui)) florent@planetscale.com
2 changes: 2 additions & 0 deletions changelog/17.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
## v17.0
* **[17.0.0](17.0.0)**
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
12 changes: 12 additions & 0 deletions changelog/7.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## v7.0
* **[7.0.3](7.0.3)**
* [Release Notes](7.0.3/release_notes.md)

* **[7.0.2](7.0.2)**
* [Release Notes](7.0.2/release_notes.md)

* **[7.0.1](7.0.1)**
* [Release Notes](7.0.1/release_notes.md)

* **[7.0.0](7.0.0)**
* [Release Notes](7.0.0/release_notes.md)
File renamed without changes.
3 changes: 3 additions & 0 deletions changelog/8.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## v8.0
* **[8.0.0](8.0.0)**
* [Release Notes](8.0.0/release_notes.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
9 changes: 9 additions & 0 deletions changelog/9.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
## v9.0
* **[9.0.2](9.0.2)**
* [Release Notes](9.0.2/release_notes.md)

* **[9.0.1](9.0.1)**
* [Release Notes](9.0.1/release_notes.md)

* **[9.0.0](9.0.0)**
* [Release Notes](9.0.0/release_notes.md)
12 changes: 12 additions & 0 deletions changelog/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## Releases
* [17.0](17.0)
* [16.0](16.0)
* [15.0](15.0)
* [14.0](14.0)
* [13.0](13.0)
* [12.0](12.0)
* [11.0](11.0)
* [10.0](10.0)
* [9.0](9.0)
* [8.0](8.0)
* [7.0](7.0)
11 changes: 6 additions & 5 deletions doc/internal/ReleaseInstructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,9 @@ That includes:
> - This includes write access to the Vitess repository and to the Maven repository.
- **Preparing and cleaning the release notes summary.**
> - One or more Pull Requests have to be submitted in advance to create and update the release summary.
> - The summary files are located in: `./doc/releasenotes/*_*_*_summary.md`.
> - The summary files are located in: `./changelog/*.0/*.*.*/summary.md`.
> - The summary file for a release candidate is the same as the one for the GA release.
> - Make sure to run `go run ./go/tools/releases/releases.go` to update the `changelog` directory with the latest release notes.
- **Finishing the blog post, and coordinating with the different organizations for cross-posting. Usually CNCF and PlanetScale. This step applies only for GA releases.**
> - The blog post must be finished and reviewed.
> - A Pull Request on the website repository of Vitess has to be created so we can easily publish the blog during the release day.
Expand Down Expand Up @@ -255,14 +256,14 @@ We need to verify that _arewefastyet_ has finished the benchmark too.
2. Run the following command to generate the release notes:
1. Release Candidate:
```shell
make VERSION="v15.0.0-rc1" FROM="v14.0.3" TO="HEAD" SUMMARY="./doc/releasenotes/15_0_0_summary.md" release-notes
make VERSION="v15.0.0-rc1" FROM="v14.0.3" TO="HEAD" SUMMARY="./changelog/15.0/15.0.0/summary.md" release-notes
```
2. General Availability:
```shell
make VERSION="v15.0.0-rc1" FROM="v14.0.3" TO="HEAD" SUMMARY="./doc/releasenotes/15_0_0_summary.md" release-notes
make VERSION="v15.0.0-rc1" FROM="v14.0.3" TO="HEAD" SUMMARY="./changelog/15.0/15.0.0/summary.md" release-notes
```
This command will generate the release notes by looking at all the commits between the tag `v14.0.3` and the reference `HEAD`.
It will also use the file located in `./doc/releasenotes/15_0_0_summary.md` to prefix the release notes with a text that the maintainers wrote before the release.
It will also use the file located in `./changelog/15.0/15.0.0/summary.md` to prefix the release notes with a text that the maintainers wrote before the release.
Please verify the generated release notes to make sure it is well-formatted and all the bookmarks are generated properly.


Expand Down Expand Up @@ -301,7 +302,7 @@ This section is divided into two parts:
git tag v15.0.0 && git tag v0.15.0 && git push origin v15.0.0 && git push origin v0.15.0
```
4. Create a Pull Request against the `main` branch with the release notes found in `doc/releasenotes/15_0_0_*.md`.
4. Create a Pull Request against the `main` branch with the release notes found in `./changelog/15.0/15.0.0/15_0_0_*.md`.
5. Run the back to dev mode tool.
```shell
Expand Down
Loading

0 comments on commit b396055

Please sign in to comment.