Re-organize the `releasenotes` directory into `changelog` #12566

frouioui · 2023-03-07T16:11:57Z

Description

This PR removes the docs/releasenotes directory and moves all the release notes into changelog/. The goal is to avoid having dozens of files at the root of docs/releasenotes, now it will be easy to navigate and read through the release notes.

The changelog directory is composed of a README that lists and links to all major releases of Vitess. It has one sub-directory for each major version. Each sub-directory is composed of another README that also lists and links all the patch release of this major release. Those sub-directories are composed of one directory per patch release. Finally, the patch release release directory contains the old files: summary, release_notes, changelog.

I have added a tool along this PR to automatically generate the different README in the changelog/** path. To run this tool do: go run ./go/tools/releases/releases.go. This tool is called in the static_check_etc CI workflow to ensure the changelog directory remains consistent as we add new files to it.

Once merged, I'll copy over the release notes that have changed to the GitHub UI release page.

Checklist

"Backport to:" labels have been added if this change should be back-ported
Tests were added or are not required
Did the new or modified tests pass consistently locally and on the CI
Documentation was added or is not required

Deployment Notes

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

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

vitess-bot · 2023-03-07T16:12:01Z

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

Ensure that the Pull Request has a descriptive title.
If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
If a test is added or modified, there should be a documentation on top of the test to explain what the expected behavior is what the test does.

If a new flag is being introduced:

Is it really necessary to add this flag?
Flag names should be clear and intuitive (as far as possible)
Help text should be descriptive.
Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

Each item in Jobs should be named in order to mark it as required.
If the workflow should be required, the maintainer team should be notified.

Bug fixes

There should be at least one unit or end-to-end test.
The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

There should be some code comments as to why things are implemented the way they are.

New/Existing features

Should be documented, either by modifying the existing documentation or creating new documentation.
New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

Protobuf changes should be wire-compatible.
Changes to _vt tables and RPCs need to be backward compatible.
vtctl command output order should be stable and awk-able.
RPC changes should be compatible with vitess-operator
If a flag is removed, then it should also be removed from VTop, if used there.

deepthi

This looks great! Approving with feedback which should be addressed before merge.

.github/workflows/static_checks_etc.yml

go/tools/releases/releases.go

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

mattlord · 2023-03-10T21:29:58Z

.github/workflows/check_label.yml

@@ -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/17_0_0_summary.md')". Once documented, the "release notes (needs details)" label can be removed.


This feels like a lot of redundant info/context for the file: 17.0 in 3 places, 17.0.0 in 2 places. Would this e.g. not be good for any reasons? ./changelog/17.0.0/summary.md?

Sounds good, fixed via 88419a3. I kept 17.0/17.0.0 but removed the prefix of the different READMEs.

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

mattlord

I like it! ❤️ I had a couple of minor nits/comments that you can address as you feel is best.

.github/workflows/static_checks_etc.yml

go/tools/releases/releases.go

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

…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>

…og` (#12566) (#12659) * Re-organize the `releasenotes` directory into `changelog` (#12566) * 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> * update the changelog dir and release_notes_label workflow Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr> --------- Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

…og` (#12566) (#12658) * Re-organize the `releasenotes` directory into `changelog` (#12566) * 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> * update the changelog dir and release_notes_label workflow Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr> --------- Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

…og` (#12566) (#12660) * Re-organize the `releasenotes` directory into `changelog` (#12566) * 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> * update the changelog dir and release_notes_label workflow Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr> --------- Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>

frouioui added 7 commits March 7, 2023 17:49

Move all release related documents to ./release and add tool to gener…

9e5368f

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

Addition of the release.go file

b620447

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

simplify release.go

31937ef

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

generate the release notes in the proper place

e246306

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

modify previous mentions of docs/releasenotes

596bfe4

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

re-add v17.0.0 summary

512b958

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

add new release tool to release instruction and ci

95f36be

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

frouioui added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Documentation docs related issues/PRs Type: Release labels Mar 7, 2023

frouioui requested review from systay, deepthi, GuptaManan100, rsajwani, mattlord and rohit-nayak-ps as code owners March 7, 2023 16:11

vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Mar 7, 2023

frouioui added Backport to: release-14.0 and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Mar 7, 2023

deepthi approved these changes Mar 8, 2023

View reviewed changes

.github/workflows/static_checks_etc.yml Outdated Show resolved Hide resolved

go/tools/releases/releases.go Show resolved Hide resolved

deepthi mentioned this pull request Mar 8, 2023

Refactor and cleanup treatment of keyspace IDs and KeyRange #12524

Merged

4 tasks

frouioui added 2 commits March 10, 2023 08:11

apply review suggestions

3e8f435

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

Merge remote-tracking branch 'origin/main' into reorg-release-dir

25fd6b8

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

mattlord reviewed Mar 10, 2023

View reviewed changes

simplify release notes document path

88419a3

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

frouioui requested a review from mattlord March 15, 2023 16:10

systay approved these changes Mar 15, 2023

View reviewed changes

mattlord approved these changes Mar 15, 2023

View reviewed changes

.github/workflows/static_checks_etc.yml Outdated Show resolved Hide resolved

go/tools/releases/releases.go Outdated Show resolved Hide resolved

go/tools/releases/releases.go Outdated Show resolved Hide resolved

frouioui added 2 commits March 16, 2023 08:53

Apply review suggestions and fix team files

c0bef3a

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

Merge remote-tracking branch 'origin/main' into reorg-release-dir

0e1a3f5

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

frouioui merged commit a8b2eae into vitessio:main Mar 20, 2023

frouioui deleted the reorg-release-dir branch March 20, 2023 08:06

austenLacy mentioned this pull request Apr 26, 2023

Fixes the SwitchTraffic bug that wasn't respecting --dry_run for readonly and replica tablets during a resharding event Shopify/vitess#91

Merged

austenLacy mentioned this pull request Aug 1, 2023

Custom jwt http ACL policy Shopify/vitess#114

Closed

hmaurer mentioned this pull request Mar 21, 2024

oops #15542

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Re-organize the `releasenotes` directory into `changelog` #12566

Re-organize the `releasenotes` directory into `changelog` #12566

frouioui commented Mar 7, 2023

vitess-bot bot commented Mar 7, 2023

deepthi left a comment

mattlord Mar 10, 2023

frouioui Mar 15, 2023

mattlord left a comment

Re-organize the releasenotes directory into changelog #12566

Re-organize the releasenotes directory into changelog #12566

Conversation

frouioui commented Mar 7, 2023

Description

Checklist

Deployment Notes

vitess-bot bot commented Mar 7, 2023

Review Checklist

General

If a new flag is being introduced:

If a workflow is added or modified:

Bug fixes

Non-trivial changes

New/Existing features

Backward compatibility

deepthi left a comment

Choose a reason for hiding this comment

mattlord Mar 10, 2023

Choose a reason for hiding this comment

frouioui Mar 15, 2023

Choose a reason for hiding this comment

mattlord left a comment

Choose a reason for hiding this comment

Re-organize the `releasenotes` directory into `changelog` #12566

Re-organize the `releasenotes` directory into `changelog` #12566