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

docs(versions): Dynamically determine latest stable & deprecated #203

Merged
merged 6 commits into from
Jun 22, 2022

Conversation

kskewes-sf
Copy link
Contributor

@kskewes-sf kskewes-sf commented Jun 22, 2022

Part of: spinnaker/spinnaker#6678

This function can be removed: https://github.com/spinnaker/buildtool/blob/master/dev/buildtool/changelog_commands.py#L552

This removes the need to add a tag deprecated to previous versions
during the release process.
Before this change when 1.27.1 is released, 1.27.0 changelog file needs
to be updated with deprecated tag.

Overall we can do this by leveraging some key ideas:

  1. changelog's contain a date: 2022-05-02 23:37:12 +0000 section in
    frontmatter that is never changed. This means a newer patch version
    for any {major.minor} will always have a newer date.
  2. we only commit to maintaining (backporting) the latest
    3 {major.minor} versions/branches.

This removes the need to add a tag `deprecated` to previous versions
during the release process.
Before this change when 1.27.1 is released, 1.27.0 changelog file needs
to be updated with `deprecated` tag.

Overall we can do this by leveraging some key ideas:
1. changelog's contain a `date: 2022-05-02 23:37:12 +0000` section in
   frontmatter that is never changed. This means a newer patch version
   for any `{major.minor}` will always have a newer `date`.
2. we only commit to maintaining (backporting) the latest
   3 {major.minor} versions/branches.
@kskewes-sf kskewes-sf changed the title docs(versions): Automatically determine latest stable & deprecated docs(versions): Dynamically determine latest stable & deprecated Jun 22, 2022
@dbyron-sf dbyron-sf merged commit 79d7d98 into spinnaker:master Jun 22, 2022
@kskewes-sf kskewes-sf deleted the changelog-dynamic-latest branch June 22, 2022 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants