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

Add changelog #259

Merged
merged 1 commit into from
Nov 8, 2023
Merged

Add changelog #259

merged 1 commit into from
Nov 8, 2023

Conversation

mjwilson-google
Copy link
Contributor

Add a changelog, so we can publish an updated working draft.

Please take a look.

@mjwilson-google mjwilson-google self-assigned this Nov 3, 2023
@hoch hoch requested review from svgeesus and removed request for svgeesus November 4, 2023 01:14
Copy link
Member

@hoch hoch left a comment

Choose a reason for hiding this comment

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

LGTM

@hoch
Copy link
Member

hoch commented Nov 4, 2023

Adding @svgeesus for visibility.

@svgeesus
Copy link
Contributor

svgeesus commented Nov 6, 2023

What does <rs-changelog from="f7632e65a5708b01fcb78ca04e254e00b5864465"> expand to? A list of commit messages? A diff?

@svgeesus
Copy link
Contributor

svgeesus commented Nov 6, 2023

Also, once the document is published, will that changelog be static and not include changes after that publication? Because typically you would start a new section Changes since Working Draft xx Nov 2023

@hoch
Copy link
Member

hoch commented Nov 6, 2023

@svgeesus rs-changelog is explained here: https://github.com/w3c/respec/wiki/rs-changelog

@mjwilson-google Can you grab a screenshot of the rendered page?

@mjwilson-google
Copy link
Contributor Author

mjwilson-google commented Nov 6, 2023

What does <rs-changelog from="f7632e65a5708b01fcb78ca04e254e00b5864465"> expand to? A list of commit messages? A diff?

It expands to a list of commit messsages which link to diffs. It's not the most user-friendly because some of the commit messsages are not very descriptive, but it's probably the fastest way to get an accurate list of everything that changed. For the from field, I manually searched and verified the first commit that landed after the last Working Draft was published.

Also, once the document is published, will that changelog be static and not include changes after that publication?

I believe so. I've never published a Respec document before, but my understanding is when we run the export step a fully static version of the page is generated and that's what we will upload as the new working draft.

Because typically you would start a new section Changes since Working Draft xx Nov 2023

Yes, although I'm a bit concerned that the changelog section will get very long if we do this. Can we just keep the changes since the previous version in the changelog, and people can go back to previous versions to check those changes?

Here is a screenshot of part of the list; we have eight years of changes so it didn't all fit on one screen:
image

@svgeesus
Copy link
Contributor

svgeesus commented Nov 8, 2023

Yes, although I'm a bit concerned that the changelog section will get very long if we do this. Can we just keep the changes since the previous version in the changelog, and people can go back to previous versions to check those changes?

Sure, that works.

@svgeesus svgeesus merged commit 34fe72c into WebAudio:gh-pages Nov 8, 2023
@mjwilson-google mjwilson-google deleted the changelog branch June 26, 2024 17:57
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.

None yet

3 participants