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

Track release notes in Git #8827

Merged
merged 6 commits into from
Feb 18, 2021
Merged

Track release notes in Git #8827

merged 6 commits into from
Feb 18, 2021

Conversation

ddbeck
Copy link
Collaborator

@ddbeck ddbeck commented Jan 21, 2021

This PR scrapes BCD's existing GitHub release notes into the repo. This is a first step toward #6759 and being able to collaborate on release notes as a routine matter for BCD.

To do this, I wrote a very ugly script that got the release details from the GitHub API and wrote out some sensible-looking Markdown. I expect that this is a one-time effort, so I didn't clean up the script and include it in this PR. I also applied a couple of other one-time cleanups:

  • convert issue autolinks (such as #1234) into proper Markdown links (e.g., [#1234](https://github.com/mdn/browser-compat-data/issues/1234))
  • convert compare autolinks (such as https://github.com/mdn/browser-compat-data/compare/v3.0.3...v3.0.4, which becomes a link with the text v3.0.3...v3.0.4) into Markdown (such as [`v3.0.3...v3.0.4`](https://github.com/mdn/browser-compat-data/compare/v3.0.3...v3.0.4))

@github-actions github-actions bot added the docs Issues or pull requests regarding the documentation of this project. label Jan 21, 2021
@Elchi3 Elchi3 self-requested a review February 15, 2021 17:00
Copy link
Member

@Elchi3 Elchi3 left a comment

Choose a reason for hiding this comment

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

Looks good to me! Not merging since I guess you might want to run the script again to include recent releases?

@ddbeck
Copy link
Collaborator Author

ddbeck commented Feb 17, 2021

@Elchi3 I added the latest releases. Also, I uppercased the file name, to line up with the other top-level directory documentation. Is that OK?

@Elchi3
Copy link
Member

Elchi3 commented Feb 18, 2021

That's okay with me. Thanks! Merging

@Elchi3 Elchi3 merged commit 6945315 into mdn:master Feb 18, 2021
@ddbeck ddbeck deleted the release-notes branch February 18, 2021 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues or pull requests regarding the documentation of this project.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants