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.

Sign up for GitHub

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
Merged

Re-organize the releasenotes directory into changelog #12566

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9e5368f
Move all release related documents to ./release and add tool to gener…
frouioui Mar 2, 2023
b620447
Addition of the release.go file
frouioui Mar 2, 2023
31937ef
simplify release.go
frouioui Mar 2, 2023
e246306
generate the release notes in the proper place
frouioui Mar 2, 2023
596bfe4
modify previous mentions of docs/releasenotes
frouioui Mar 7, 2023
512b958
re-add v17.0.0 summary
frouioui Mar 7, 2023
95f36be
add new release tool to release instruction and ci
frouioui Mar 7, 2023
3e8f435
apply review suggestions
frouioui Mar 10, 2023
25fd6b8
Merge remote-tracking branch 'origin/main' into reorg-release-dir
frouioui Mar 10, 2023
88419a3
simplify release notes document path
frouioui Mar 15, 2023
c0bef3a
Apply review suggestions and fix team files
frouioui Mar 16, 2023
0e1a3f5
Merge remote-tracking branch 'origin/main' into reorg-release-dir
frouioui Mar 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
generate the release notes in the proper place 
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
  • Loading branch information
@frouioui
frouioui committed Mar 7, 2023
commit e246306ee83a41a32fc3da9df5b19dd85e662245
22 changes: 17 additions & 5 deletions go/tools/release-notes/release_notes.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,13 @@ type (
}
)

const (
releaseNotesPath = `doc/releasenotes/`
releaseNotesPathGitHub = `https://github.com/vitessio/vitess/blob/main/` + releaseNotesPath
var (
releaseNotesPath = `changelog/`
)

markdownTemplate = `# Release of Vitess {{.Version}}
const (
releaseNotesPathGitHub = `https://github.com/vitessio/vitess/blob/main/`
markdownTemplate = `# Release of Vitess {{.Version}}

{{- if or .Announcement .AddDetails }}
{{ .Announcement }}
Expand Down Expand Up @@ -138,7 +140,7 @@ The entire changelog for this release can be found [here]({{ .PathToChangeLogFil
func (rn *releaseNote) generate(rnFile, changelogFile *os.File) error {
var err error
// Generate the release notes
rn.PathToChangeLogFileOnGH = fmt.Sprintf(releaseNotesPathGitHub+"%s_changelog.md", rn.VersionUnderscore)
rn.PathToChangeLogFileOnGH = fmt.Sprintf(releaseNotesPathGitHub+releaseNotesPath+"%s_changelog.md", rn.VersionUnderscore)
if rnFile == nil {
rnFile, err = os.OpenFile(fmt.Sprintf(path.Join(releaseNotesPath, "%s_release_notes.md"), rn.VersionUnderscore), os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0666)
if err != nil {
Expand Down Expand Up @@ -506,6 +508,16 @@ func main() {
log.Fatal("The --version flag must be set using a valid format. Format: 'vX.X.X'.")
}

// Define the path to the release notes folder
majorVersion := versionMatch[1] + "." + versionMatch[2]
patchVersion := versionMatch[0]
releaseNotesPath = path.Join(releaseNotesPath, majorVersion, patchVersion)

err := os.MkdirAll(releaseNotesPath, os.ModePerm)
if err != nil {
log.Fatal(err)
}

releaseNotes := releaseNote{
Version: versionName,
VersionUnderscore: fmt.Sprintf("%s_%s_%s", versionMatch[1], versionMatch[2], versionMatch[3]), // v14.0.0 -> 14_0_0, this is used to format filenames.
Expand Down