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

feat: generate changelog from PRs #587

Merged
merged 2 commits into from
Oct 22, 2020
Merged

feat: generate changelog from PRs #587

merged 2 commits into from
Oct 22, 2020

Conversation

sgratzl
Copy link
Member

@sgratzl sgratzl commented Oct 22, 2020

Prerequisites:

  • Unless it is a hotfix it should be merged against the dev branch
  • Branch is up-to-date with the branch to be merged with, i.e. dev
  • Build is successful
  • Code is cleaned up and formatted

Summary

adds a script npm run changelog that will update a CHANGELOG.md file based on the PRs merged between the current checkout out version and the latest main state.

when running right now it will look like:

# Release 1.9.3

## New Features

- [#543](https://github.com/cmu-delphi/www-covidcast/pull/543) Enforce county geo type
- [#558](https://github.com/cmu-delphi/www-covidcast/pull/558) Update population data based on indicator data
- [#530](https://github.com/cmu-delphi/www-covidcast/pull/530) Generate signal constants
- [#526](https://github.com/cmu-delphi/www-covidcast/pull/526) Add background to map title for visibility
- [#545](https://github.com/cmu-delphi/www-covidcast/pull/545) Add date shortcuts
- [#551](https://github.com/cmu-delphi/www-covidcast/pull/551) Enforce 0 is no bubble

## Bug-fixes

- [#541](https://github.com/cmu-delphi/www-covidcast/pull/541) Add aria label to map
- [#460](https://github.com/cmu-delphi/www-covidcast/pull/460) Add missing county level to quidel
- [#535](https://github.com/cmu-delphi/www-covidcast/pull/535) Incomplete imputation in detail view
- [#514](https://github.com/cmu-delphi/www-covidcast/pull/514) Set aria option for no-uislider
- [#515](https://github.com/cmu-delphi/www-covidcast/pull/515) Fix vega warning

## Others

- [#552](https://github.com/cmu-delphi/www-covidcast/pull/552) Use local maxima for top 10
- [#571](https://github.com/cmu-delphi/www-covidcast/pull/571) Making toggle selection darker
- [#574](https://github.com/cmu-delphi/www-covidcast/pull/574) Add day ticks and week gridlines for Detail view.
- [#524](https://github.com/cmu-delphi/www-covidcast/pull/524) Re-enable side panel toggle
- [#525](https://github.com/cmu-delphi/www-covidcast/pull/525) Search icon and na hint
- [#542](https://github.com/cmu-delphi/www-covidcast/pull/542) Tune export data tab
- [#544](https://github.com/cmu-delphi/www-covidcast/pull/544) Coverage info
- [#566](https://github.com/cmu-delphi/www-covidcast/pull/566) Improve vega highlight performance
- [#568](https://github.com/cmu-delphi/www-covidcast/pull/568) Dlaliberte/#563
- [#546](https://github.com/cmu-delphi/www-covidcast/pull/546) Single location view
- [#556](https://github.com/cmu-delphi/www-covidcast/pull/556) Add download button to detail views
- [#523](https://github.com/cmu-delphi/www-covidcast/pull/523) Sync main -> dev
- [#548](https://github.com/cmu-delphi/www-covidcast/pull/548) Change max mobile width for mode nav buttons

@tildechris is that what you imagined?

@sgratzl sgratzl requested a review from tildechris October 22, 2020 18:31
@netlify
Copy link

netlify bot commented Oct 22, 2020

Preview link ready!

Built with commit af9be8e

https://deploy-preview-587--cmu-delphi-covidcast.netlify.app

@tildechris
Copy link
Contributor

Yes! This works great.

Is there an easy way to also link in associated issues? I'm thinking it'd be nice to have something like this:

@sgratzl
Copy link
Member Author

sgratzl commented Oct 22, 2020

as mentioned in slack, I haven't found a way to get the linked issues for an PR (as listed in the side panel of an PR). One could parse out the closes out of the PR body but that isn't reliable.

@tildechris
Copy link
Contributor

One could parse out the closes out of the PR body but that isn't reliable.

Actually, I think this a reasonable thing to do. Regex for \#[0-9]+ from the PR description and simply pull those out. Then you'd see something like Fixes #587, related to #134, as we discussed in #444 -> #123 (re: #587, #134, #444). Thoughts?

@sgratzl
Copy link
Member Author

sgratzl commented Oct 22, 2020

then it will generate

# Release 1.9.3

## New Features

- [#543](https://github.com/cmu-delphi/www-covidcast/pull/543) (re: [#482](https://github.com/cmu-delphi/www-covidcast/issues/482)) Enforce county geo type
- [#558](https://github.com/cmu-delphi/www-covidcast/pull/558) (re: [#553](https://github.com/cmu-delphi/www-covidcast/issues/553)) Update population data based on indicator data
- [#530](https://github.com/cmu-delphi/www-covidcast/pull/530) (re: [#522](https://github.com/cmu-delphi/www-covidcast/issues/522)) Generate signal constants
- [#526](https://github.com/cmu-delphi/www-covidcast/pull/526) (re: [#512](https://github.com/cmu-delphi/www-covidcast/issues/512)) Add background to map title for visibility
- [#545](https://github.com/cmu-delphi/www-covidcast/pull/545) (re: [#478](https://github.com/cmu-delphi/www-covidcast/issues/478)) Add date shortcuts
- [#551](https://github.com/cmu-delphi/www-covidcast/pull/551) (re: [#493](https://github.com/cmu-delphi/www-covidcast/issues/493)) Enforce 0 is no bubble

## Bug-fixes

- [#541](https://github.com/cmu-delphi/www-covidcast/pull/541) (re: [#528](https://github.com/cmu-delphi/www-covidcast/issues/528)) Add aria label to map
- [#460](https://github.com/cmu-delphi/www-covidcast/pull/460) (re: [#539](https://github.com/cmu-delphi/www-covidcast/issues/539)) Add missing county level to quidel
- [#535](https://github.com/cmu-delphi/www-covidcast/pull/535) (re: [#534](https://github.com/cmu-delphi/www-covidcast/issues/534)) Incomplete imputation in detail view
- [#514](https://github.com/cmu-delphi/www-covidcast/pull/514) (re: [#513](https://github.com/cmu-delphi/www-covidcast/issues/513)) Set aria option for no-uislider
- [#515](https://github.com/cmu-delphi/www-covidcast/pull/515) Fix vega warning

## Others

- [#552](https://github.com/cmu-delphi/www-covidcast/pull/552) Use local maxima for top 10
- [#571](https://github.com/cmu-delphi/www-covidcast/pull/571) (re: [#477](https://github.com/cmu-delphi/www-covidcast/issues/477)) Making toggle selection darker
- [#574](https://github.com/cmu-delphi/www-covidcast/pull/574) (re: [#563](https://github.com/cmu-delphi/www-covidcast/issues/563)) Add day ticks and week gridlines for Detail view.
- [#524](https://github.com/cmu-delphi/www-covidcast/pull/524) (re: [#518](https://github.com/cmu-delphi/www-covidcast/issues/518), [#517](https://github.com/cmu-delphi/www-covidcast/issues/517)) Re-enable side panel toggle
- [#525](https://github.com/cmu-delphi/www-covidcast/pull/525) (re: [#519](https://github.com/cmu-delphi/www-covidcast/issues/519), [#516](https://github.com/cmu-delphi/www-covidcast/issues/516)) Search icon and na hint
- [#542](https://github.com/cmu-delphi/www-covidcast/pull/542) (re: [#532](https://github.com/cmu-delphi/www-covidcast/issues/532), [#533](https://github.com/cmu-delphi/www-covidcast/issues/533), [#483](https://github.com/cmu-delphi/www-covidcast/issues/483), [#521](https://github.com/cmu-delphi/www-covidcast/issues/521)) Tune export data tab
- [#544](https://github.com/cmu-delphi/www-covidcast/pull/544) (re: [#540](https://github.com/cmu-delphi/www-covidcast/issues/540), [#538](https://github.com/cmu-delphi/www-covidcast/issues/538)) Coverage info
- [#566](https://github.com/cmu-delphi/www-covidcast/pull/566) Improve vega highlight performance
- [#568](https://github.com/cmu-delphi/www-covidcast/pull/568) (re: [#563](https://github.com/cmu-delphi/www-covidcast/issues/563)) Dlaliberte/#563
- [#546](https://github.com/cmu-delphi/www-covidcast/pull/546) (re: [#540](https://github.com/cmu-delphi/www-covidcast/issues/540)) Single location view
- [#556](https://github.com/cmu-delphi/www-covidcast/pull/556) (re: [#484](https://github.com/cmu-delphi/www-covidcast/issues/484)) Add download button to detail views
- [#523](https://github.com/cmu-delphi/www-covidcast/pull/523) Sync main -> dev
- [#548](https://github.com/cmu-delphi/www-covidcast/pull/548) (re: [#520](https://github.com/cmu-delphi/www-covidcast/issues/520)) Change max mobile width for mode nav buttons

Copy link
Contributor

@tildechris tildechris left a comment

Choose a reason for hiding this comment

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

LGTM, thanks Sam!

@sgratzl sgratzl self-assigned this Oct 22, 2020
@sgratzl sgratzl merged commit 230044f into dev Oct 22, 2020
@sgratzl sgratzl deleted the sgratzl/changelog branch October 22, 2020 19:50
@sgratzl sgratzl linked an issue Oct 22, 2020 that may be closed by this pull request
@dlaliberte
Copy link
Contributor

dlaliberte commented Oct 22, 2020 via email

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.

Create a method to automatically generate release notes
3 participants