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 a script to generate GitHub release notes #3199

Merged
merged 7 commits into from
Jan 11, 2019
Merged

Conversation

ddbeck
Copy link
Collaborator

@ddbeck ddbeck commented Dec 11, 2018

Based on our discussion on documenting release notes #3158 (comment) I wrote a script to generate (some but not all) release notes and pre-populate the GitHub release page.

I wasn't able to automate all of it, so I prompt for some information instead. Let me know what you think!

@ddbeck ddbeck requested a review from Elchi3 December 11, 2018 15:10
@ddbeck ddbeck added the infra 🏗️ Infrastructure issues (npm, GitHub Actions, releases) of this project label Dec 11, 2018
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.

Really cool little automation here :) Thanks, Daniel! 👍

I have two things I wondered about while running the for the latest release just now. See comments inline.
And then I wonder where this should live. tests/ is probably okay? (render.js is in there as well). Or should we start an infamous utils folder? 😄

Will have a closer look at the code and the newly added devDependency once I have more time available.

test/release-notes.js Outdated Show resolved Hide resolved
test/release-notes.js Show resolved Hide resolved
@ddbeck
Copy link
Collaborator Author

ddbeck commented Dec 20, 2018

Just ran through the release process myself for the first time and fixed up a few small issues I ran into (typos and setting the prerelease checkbox—that last one we'll have to change when we hit 1.0, I guess).

@ExE-Boss
Copy link
Contributor

This will conflict with #2338, which I’d like to merge first for reasons outlined in #2338 (comment).

@ddbeck
Copy link
Collaborator Author

ddbeck commented Jan 2, 2019

@ExE-Boss the conflict being the package-lock.json changes, right? I think that might be another point in favor of not adding an additional dependency here and rewriting it to do without.

@ddbeck
Copy link
Collaborator Author

ddbeck commented Jan 8, 2019

OK, I'm going to:

  • rewrite this without the new dependency
  • update the docs to point to this script (just noticed I had forgotten)

I'll do this by the end of the day Wednesday, so it can be ready for @Elchi3 to try it again on the next release.

@ddbeck
Copy link
Collaborator Author

ddbeck commented Jan 8, 2019

@Elchi3 I've undone adding a dependency (the resulting code isn't too gnarly, I hope) and updated the docs. Please give this a try on the next release. Thank you!

@ddbeck
Copy link
Collaborator Author

ddbeck commented Jan 8, 2019

Oh yeah to address the earlier question: yes, I kinda think we should have a utils folder (or maybe meta or project or something like that?), but I think we ought to do that in a separate PR.

@ExE-Boss
Copy link
Contributor

ExE-Boss commented Jan 8, 2019

Or maybe a scripts or a bin directory.

@Elchi3
Copy link
Member

Elchi3 commented Jan 11, 2019

I've tried this yesterday and it worked flawlessly. I'm glancing over it again now, but I think it is all good :)

I like the idea of a scripts/ directory. render.js should live there as well. Maybe more in the future.

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.

Approving and merging this. 🎉

@Elchi3 Elchi3 merged commit 2d8f8cf into mdn:master Jan 11, 2019
@ddbeck ddbeck deleted the release-script branch January 11, 2019 14:57
ddbeck added a commit to ddbeck/browser-compat-data that referenced this pull request Jan 11, 2019
Elchi3 pushed a commit that referenced this pull request Jan 11, 2019
@queengooborg queengooborg added the scripts 📜 Issues or pull requests regarding the scripts in scripts/. label Jan 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infra 🏗️ Infrastructure issues (npm, GitHub Actions, releases) of this project scripts 📜 Issues or pull requests regarding the scripts in scripts/.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants