chore(build): Update docs site changelog generation #48
Conversation
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
Instead of making a new gist for each patch release, we'll now use a single top-level gist for each minor release, and put the release notes for each patch version in a separate file in the gist (ex: 1.18.0.md, 1.19.1.md). We'll no longer copy-paste the prior release's full changelog into each patch release's changes. Instead, we'll just refer to all prior patch releases by reference in the docs site, avoiding a lot of copy-paste and duplication. (And if ever we needed to amend the release notes for an old version we'd currently need to do that everywhere it was copy-pasted but now only in one place.) This commit updates the code that generates the new file in spinnaker.github.io to pull in the new changelog. It pulls in reverse order the file corresponding to every patch release in the current minor version. It also fixes the fact that we were incorrectly using a self-closing tag for the script element which is not allowed.
|
@spinnakerbot cherry-pick 1.19 |
spinnakerbot
pushed a commit
that referenced
this pull request
Mar 20, 2020
Instead of making a new gist for each patch release, we'll now use a single top-level gist for each minor release, and put the release notes for each patch version in a separate file in the gist (ex: 1.18.0.md, 1.19.1.md). We'll no longer copy-paste the prior release's full changelog into each patch release's changes. Instead, we'll just refer to all prior patch releases by reference in the docs site, avoiding a lot of copy-paste and duplication. (And if ever we needed to amend the release notes for an old version we'd currently need to do that everywhere it was copy-pasted but now only in one place.) This commit updates the code that generates the new file in spinnaker.github.io to pull in the new changelog. It pulls in reverse order the file corresponding to every patch release in the current minor version. It also fixes the fact that we were incorrectly using a self-closing tag for the script element which is not allowed.
|
Cherry pick successful: #58 |
spinnakerbot
pushed a commit
that referenced
this pull request
Mar 20, 2020
Instead of making a new gist for each patch release, we'll now use a single top-level gist for each minor release, and put the release notes for each patch version in a separate file in the gist (ex: 1.18.0.md, 1.19.1.md). We'll no longer copy-paste the prior release's full changelog into each patch release's changes. Instead, we'll just refer to all prior patch releases by reference in the docs site, avoiding a lot of copy-paste and duplication. (And if ever we needed to amend the release notes for an old version we'd currently need to do that everywhere it was copy-pasted but now only in one place.) This commit updates the code that generates the new file in spinnaker.github.io to pull in the new changelog. It pulls in reverse order the file corresponding to every patch release in the current minor version. It also fixes the fact that we were incorrectly using a self-closing tag for the script element which is not allowed.
|
Cherry pick successful: #59 |
spinnakerbot
pushed a commit
that referenced
this pull request
Mar 20, 2020
Instead of making a new gist for each patch release, we'll now use a single top-level gist for each minor release, and put the release notes for each patch version in a separate file in the gist (ex: 1.18.0.md, 1.19.1.md). We'll no longer copy-paste the prior release's full changelog into each patch release's changes. Instead, we'll just refer to all prior patch releases by reference in the docs site, avoiding a lot of copy-paste and duplication. (And if ever we needed to amend the release notes for an old version we'd currently need to do that everywhere it was copy-pasted but now only in one place.) This commit updates the code that generates the new file in spinnaker.github.io to pull in the new changelog. It pulls in reverse order the file corresponding to every patch release in the current minor version. It also fixes the fact that we were incorrectly using a self-closing tag for the script element which is not allowed.
|
Cherry pick successful: #60 |
ezimanyi
added a commit
that referenced
this pull request
Mar 20, 2020
Instead of making a new gist for each patch release, we'll now use a single top-level gist for each minor release, and put the release notes for each patch version in a separate file in the gist (ex: 1.18.0.md, 1.19.1.md). We'll no longer copy-paste the prior release's full changelog into each patch release's changes. Instead, we'll just refer to all prior patch releases by reference in the docs site, avoiding a lot of copy-paste and duplication. (And if ever we needed to amend the release notes for an old version we'd currently need to do that everywhere it was copy-pasted but now only in one place.) This commit updates the code that generates the new file in spinnaker.github.io to pull in the new changelog. It pulls in reverse order the file corresponding to every patch release in the current minor version. It also fixes the fact that we were incorrectly using a self-closing tag for the script element which is not allowed. Co-authored-by: Eric Zimanyi <ezimanyi@google.com>
ezimanyi
added a commit
that referenced
this pull request
Mar 20, 2020
Instead of making a new gist for each patch release, we'll now use a single top-level gist for each minor release, and put the release notes for each patch version in a separate file in the gist (ex: 1.18.0.md, 1.19.1.md). We'll no longer copy-paste the prior release's full changelog into each patch release's changes. Instead, we'll just refer to all prior patch releases by reference in the docs site, avoiding a lot of copy-paste and duplication. (And if ever we needed to amend the release notes for an old version we'd currently need to do that everywhere it was copy-pasted but now only in one place.) This commit updates the code that generates the new file in spinnaker.github.io to pull in the new changelog. It pulls in reverse order the file corresponding to every patch release in the current minor version. It also fixes the fact that we were incorrectly using a self-closing tag for the script element which is not allowed. Co-authored-by: Eric Zimanyi <ezimanyi@google.com>
ezimanyi
added a commit
that referenced
this pull request
Mar 20, 2020
Instead of making a new gist for each patch release, we'll now use a single top-level gist for each minor release, and put the release notes for each patch version in a separate file in the gist (ex: 1.18.0.md, 1.19.1.md). We'll no longer copy-paste the prior release's full changelog into each patch release's changes. Instead, we'll just refer to all prior patch releases by reference in the docs site, avoiding a lot of copy-paste and duplication. (And if ever we needed to amend the release notes for an old version we'd currently need to do that everywhere it was copy-pasted but now only in one place.) This commit updates the code that generates the new file in spinnaker.github.io to pull in the new changelog. It pulls in reverse order the file corresponding to every patch release in the current minor version. It also fixes the fact that we were incorrectly using a self-closing tag for the script element which is not allowed. Co-authored-by: Eric Zimanyi <ezimanyi@google.com>
maggieneterval
added a commit
to maggieneterval/deck
that referenced
this pull request
Jun 15, 2020
Since [this change](spinnaker/buildtool#48) to spinnaker/buildtool, the OSS release changelog gists have been published with one top-level gist per minor release and individual files for each patch release. Since we can now stably link to each patch release changelog on spinnaker.io, let's point the Help --> Version link there rather than the general Releases page, which just links out ot each individual changelog anyway.
maggieneterval
added a commit
to spinnaker/deck
that referenced
this pull request
Jun 16, 2020
Since [this change](spinnaker/buildtool#48) to spinnaker/buildtool, the OSS release changelog gists have been published with one top-level gist per minor release and individual files for each patch release. Since we can now stably link to each patch release changelog on spinnaker.io, let's point the Help --> Version link there rather than the general Releases page, which just links out ot each individual changelog anyway.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Instead of making a new gist for each patch release, we'll now use a single top-level gist for each minor release, and put the release notes for each patch version in a separate file in the gist (ex: 1.18.0.md, 1.19.1.md).
We'll no longer copy-paste the prior release's full changelog into each patch release's changes. Instead, we'll just refer to all prior patch releases by reference in the docs site, avoiding a lot of copy-paste and duplication. (And if ever we needed to amend the release notes for an old version we'd currently need to do that everywhere it was copy-pasted but now only in one place.)
This commit updates the code that generates the new file in spinnaker.github.io to pull in the new changelog. It pulls in reverse order the file corresponding to every patch release in the current minor version. It also fixes the fact that we were incorrectly using a self-closing tag for the script element which is not allowed.