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.

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

chore(build): Update docs site changelog generation (#48) #59

Conversation

spinnakerbot
Copy link
Collaborator

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.

Automated cherry pick of 5623cb3 into 1.18

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.
@ezimanyi ezimanyi merged commit 267b5a8 into release-1.18.x Mar 20, 2020
@ezimanyi ezimanyi deleted the auto-cherry-pick-1.18-5623cb39528f97052bbd6a9ca2a077535489ab78 branch March 20, 2020 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants