Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.Sign up
GitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
x/website: make it safer to make changes to draft release notes #37072
Right now we rely on https://tip.golang.org (served by the
Always showing the latest Go+x/website commits means that changes to the draft release notes are previewed very quickly, which is great for seeing the latest state and for spotting problems very quickly. However, release notes use template processing, and if there is an error in the template, an error is displayed. That makes editing the draft release notes a risky process, which can cause times where draft release notes can't be viewed (see #37070 recently).
We should find a way to make the process safer, but hopefully without negatively affecting the convenience of being able to see the latest commits without manual effort.
Given that the release notes are largely HTML (with a minor template component) inside the
I've searched through the release notes for many Go releases, and I'm seeing that most of them do not actually use the template functionality for anything, other than to escape
I see that
But none of the other releases (1.1 through 1.14) do.
I forgot to escape them in CL 217877, and the TryBots don't currently catch template errors in HTML docs. Updates golang/go#37042 Updates golang/go#37072 Change-Id: Ia7b82a9c9b85914f224c04050bfbe3747d5a3acc Reviewed-on: https://go-review.googlesource.com/c/website/+/218217 Run-TryBot: Bryan C. Mills <firstname.lastname@example.org> TryBot-Result: Gobot Gobot <email@example.com> Reviewed-by: Ian Lance Taylor <firstname.lastname@example.org>
There are no template features being used in either of these two files, so convert them to regular non-template HTML files. Having template be off has proven to be a safer default, and it uses less CPU. For golang/go#37070. For golang/go#37072. For golang/go#37090. Change-Id: Ib0de115e58c51a9660d648dbb8793fcaae9a7197 Reviewed-on: https://go-review.googlesource.com/c/website/+/229079 Reviewed-by: Alexander Rakoczy <email@example.com>