Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-organize the releasenotes directory into changelog #12566

Merged
merged 12 commits into from
Mar 20, 2023
Prev Previous commit
Next Next commit
apply review suggestions
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
  • Loading branch information
frouioui committed Mar 10, 2023
commit 3e8f435bd2703a80d62dc7921d9c77e9f40b8287
2 changes: 1 addition & 1 deletion .github/workflows/static_checks_etc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -220,5 +220,5 @@ jobs:
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 this CI test yields with the following changes:'
echo 'Running `go run ./go/tools/releases/releases.go` on CI yields the following changes:'
echo "$output"
frouioui marked this conversation as resolved.
Show resolved Hide resolved
13 changes: 13 additions & 0 deletions go/tools/releases/releases.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,19 @@ limitations under the License.

package main
frouioui marked this conversation as resolved.
Show resolved Hide resolved

// 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 releases of this major release. Those sub-directories
// are composed of one directory per patch release. Finally,
// the patch release directory contains the old files markdown:
// summary, release_notes, changelog.
//
// This tool is solely responsible for generating the READMEs
// and making sure they are up-to-date with the list of major
// and patch releases we have.

import (
"log"
"os"
Expand Down