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

Generate unstable changelogs using towncrier #1340

Merged
merged 8 commits into from Nov 15, 2022
Merged

Conversation

richvdh
Copy link
Member

@richvdh richvdh commented Nov 15, 2022

Replace the current stack of hugo templates with a towncrier invocation. The main advantage of this is that it means that the "Changes since last release" section is consistent with the changelogs for the actual releases.

This also changes the release process so that the changelog is generated before tagging, which means that the thing tagged v1.5 is actually the v1.5 spec.

Fixes #908.

Suggest reviewing commit-by-commit.

Preview: https://pr1340--matrix-spec-previews.netlify.app

@richvdh richvdh requested a review from a team as a code owner November 15, 2022 18:02
@richvdh richvdh marked this pull request as draft November 15, 2022 18:02
Copy link
Member

@turt2live turt2live left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clearing code review while draft, also just a note to please update the release documentation to accomodate the change.

@richvdh richvdh force-pushed the rav/cleaner_changelogs branch 2 times, most recently from 9e4306e to d64bed2 Compare November 15, 2022 19:24
... which means we don't need to edit the top-level page for each release.
@richvdh richvdh marked this pull request as ready for review November 15, 2022 19:48
@richvdh richvdh requested a review from a team November 15, 2022 19:48
*/}}

{{ with .Page.Resources.Match "*.md" }}
{{ range ((sort . "Name" "desc")) }}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will this cause a problem when we get to v1.10 or v10.0?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bleh. yes.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've fixed this by including the timestamp of when the changelog was generated in the file, and sorting by that instead.

Copy link
Member

@turt2live turt2live left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

otherwise lgtm

Copy link
Member

@turt2live turt2live left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks :)

and doubly thanks for going back in time to find the dates of each release.

@richvdh
Copy link
Member Author

richvdh commented Nov 15, 2022

and doubly thanks for going back in time to find the dates of each release.

I mean they are written three lines below in each changelog, but I'll take the thanks :)

@richvdh richvdh merged commit 08fde5f into main Nov 15, 2022
@richvdh richvdh deleted the rav/cleaner_changelogs branch November 15, 2022 23:26
@turt2live
Copy link
Member

and doubly thanks for going back in time to find the dates of each release.

I mean they are written three lines below in each changelog, but I'll take the thanks :)

considering that's more effort than I put into reading the changelogs, thank you 😇

clokep pushed a commit to clokep/matrix-spec that referenced this pull request May 3, 2023
Replace the current stack of hugo templates with a towncrier invocation. The main advantage of this is that it means that the "Changes since last release" section is consistent with the changelogs for the actual releases.

This also changes the release process so that the changelog is generated before tagging, which means that the thing tagged v1.5 is actually the v1.5 spec.

Fixes matrix-org#908.
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.

Changelog is not collapsing entries
2 participants