x/website: make it safer to make changes to templated HTML pages #37090
Labels
FrozenDueToAge
NeedsInvestigation
Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Testing
An issue that has been verified to require only test changes, not just a test failure.
Milestone
Comments
dmitshur
added
Testing
|
Change https://golang.org/cl/229079 mentions this issue: |
gopherbot
pushed a commit
to golang/website
that referenced
this issue
Apr 20, 2020
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 protected]>
|
Change https://golang.org/cl/229081 mentions this issue: |
gopherbot
pushed a commit
to golang/website
that referenced
this issue
Apr 21, 2020
Previously, the release history page was a raw HTML file that was manually edited whenever new Go releases were made. This change converts release history entries into a structured format in the new internal/history package, and generates release history entries from that format. For now, only Go 1.9 and newer releases are converted, but the structured format is flexible enough to represent all releases going back to the original Go 1 release. Various English grammar rules and special cases are preserved, so that the release history entries appear in a consistent way. New release history entries need only to be added to the internal/ history package, making it so that English grammar rules and HTML tags don't need to go through human code review for each release. Future work may involve constructing that list from data already available in the Go issue tracker. This change makes minimal contributions to reducing the dependence of x/website on the x/tools/godoc rendering engine for displaying pages other than Go package documentation. The x/tools/godoc code is in another module and does not provide flexibility desired for the general purpose website needs of x/website. Fixes golang/go#38488. For golang/go#37090. For golang/go#29206. Change-Id: I80864e4f218782e6e3b5fcd5a1d63f3699314c81 Reviewed-on: https://go-review.googlesource.com/c/website/+/229081 Run-TryBot: Dmitri Shuralyov <[email protected]> TryBot-Result: Gobot Gobot <[email protected]> Reviewed-by: Alexander Rakoczy <[email protected]>
|
I just wrote templatecheck, a package that validates templates after they are parsed. It might help with this issue. |
|
Change https://go.dev/cl/393357 mentions this issue: |
|
The original issue stated:
This is no longer the case today. As documented in Closing as fixed. Thanks to Russ who authored the |
passionSeven
added a commit
to passionSeven/website
that referenced
this issue
Oct 18, 2022
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 protected]>
passionSeven
added a commit
to passionSeven/website
that referenced
this issue
Oct 18, 2022
Previously, the release history page was a raw HTML file that was manually edited whenever new Go releases were made. This change converts release history entries into a structured format in the new internal/history package, and generates release history entries from that format. For now, only Go 1.9 and newer releases are converted, but the structured format is flexible enough to represent all releases going back to the original Go 1 release. Various English grammar rules and special cases are preserved, so that the release history entries appear in a consistent way. New release history entries need only to be added to the internal/ history package, making it so that English grammar rules and HTML tags don't need to go through human code review for each release. Future work may involve constructing that list from data already available in the Go issue tracker. This change makes minimal contributions to reducing the dependence of x/website on the x/tools/godoc rendering engine for displaying pages other than Go package documentation. The x/tools/godoc code is in another module and does not provide flexibility desired for the general purpose website needs of x/website. Fixes golang/go#38488. For golang/go#37090. For golang/go#29206. Change-Id: I80864e4f218782e6e3b5fcd5a1d63f3699314c81 Reviewed-on: https://go-review.googlesource.com/c/website/+/229081 Run-TryBot: Dmitri Shuralyov <[email protected]> TryBot-Result: Gobot Gobot <[email protected]> Reviewed-by: Alexander Rakoczy <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Issue #37072 was about making it safer to make changes to draft release notes. But the golang.org website (and in turn, the tip copy at tip.golang.org) still has many pages that use templates.
Right now, if a change introduces an error on one of the templated pages, there isn't a test or trybot that catches that error. We should find a way to automate finding this kind of a problem, otherwise it can lead to broken pages on golang.org (when manually deployed, if the deployment regression tests don't catch it) and tip.golang.org (which is automatically deployed as soon as the CL is submitted).
See CL 217877 and CL 218217 for a recent occurrence that should ideally be caught in the future.
/cc @bcmills @golang/osp-team
The text was updated successfully, but these errors were encountered: