-
Notifications
You must be signed in to change notification settings - Fork 331
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
cmd/golangorg: add doc/next page to preview draft release notes
The improved release note process is being used starting with Go 1.23. That means instead of a single doc/go1.23.html draft file in the main Go repository, doc/next contains a set of release note fragments. Having small, orthogonal files avoids merge conflicts, and a release note test requires that release notes are written and included in the same CL that's adding new APIs. As a result, the set of completed release notes even before we enter the release freeze is greater than ever before. While it's possible to view those fragments using tip.golang.org (e.g., by visiting https://tip.golang.org/doc/next), reading them that way isn't practical. The relnote generate tool exists to merge fragments into a complete Markdown document, and this tool will be used when eventually moving a complete draft of Go 1.23 release notes to x/website. To aid the remaining work of completing the release note draft, this change adds a dynamic /doc/next page to preview what the relnote generate tool will produce. Combined with existing functionality of the -tip flag, it makes https://tip.golang.org/doc/next display a live preview of the checked-in release notes draft. It can also be used to preview release note draft locally. For example, if $HOME/gotip is a Go checkout where one is editing doc/next content: go run golang.org/x/website/cmd/golangorg@latest -goroot=$HOME/gotip Will serve a live preview at http://localhost:6060/go.dev/doc/next. It can be slightly more convenient to refresh a browser without having to re-run 'relnote generate'. For golang/go#64169. For golang/go#65614. Change-Id: Ie1d3650076421a95a691dd84a554a113dd1187b1 Reviewed-on: https://go-review.googlesource.com/c/website/+/587436 Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Auto-Submit: Dmitri Shuralyov <dmitshur@golang.org> Reviewed-by: Jonathan Amsterdam <jba@google.com>
- Loading branch information
Showing
5 changed files
with
50 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
title: Next Release Notes Draft | ||
template: true | ||
--- | ||
|
||
{{with docNext}}{{.}}{{else}}No next release note fragments available.{{end}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters