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 CHANGELOG from PRs labeled with changelog #510

Merged
merged 2 commits into from
Nov 9, 2022

Conversation

asimpson
Copy link
Contributor

@asimpson asimpson commented Nov 7, 2022

The goal of this config is to minimize discussion/decisions on what to include in the CHANGELOG when cutting a new release by moving the decision point to PR creation via the changelog label instead of release creation.

New Flow

  1. Mark PRs for inclusion in the CHANGELOG as they are created by tagging the PRs with the label changelog.
  2. When it comes time to cut a release use the generate release notes feature to generate the list of PRs to include in the CHANGELOG and then copy and paste them into the CHANGELOG.
  3. PR the changes to the CHANGELOG along with the new version.
  4. Once the PR is merged and the Drone build is passing go into Drone and "Promote the build" to release the new version.

Also adds a PR template with guidance on how to word PR titles.
@asimpson asimpson requested a review from a team as a code owner November 7, 2022 21:05
@github-actions
Copy link

github-actions bot commented Nov 7, 2022

Backend code coverage report for PR #510
No changes

@github-actions
Copy link

github-actions bot commented Nov 7, 2022

Frontend code coverage report for PR #510
No changes

Copy link
Contributor

@aangelisc aangelisc left a comment

Choose a reason for hiding this comment

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

Nice work here 😊 I'd suggest we exclude PRs authored by dependabot from the CHANGELOG to avoid it getting messy, wdyt?

Copy link
Contributor

@andresmgot andresmgot left a comment

Choose a reason for hiding this comment

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

Sounds good! Can you add the updated instructions to the CONTRIBUTING file?

@andresmgot
Copy link
Contributor

I'd suggest we exclude PRs authored by dependabot from the CHANGELOG to avoid it getting messy, wdyt?

as far as I understood, those PR won't have the label: changelog so they won't be added to the final changelog, right?

@aangelisc
Copy link
Contributor

I'd suggest we exclude PRs authored by dependabot from the CHANGELOG to avoid it getting messy, wdyt?

as far as I understood, those PR won't have the label: changelog so they won't be added to the final changelog, right?

That's correct my bad, I misunderstood 🙃

@asimpson
Copy link
Contributor Author

asimpson commented Nov 8, 2022

@andresmgot @aangelisc yep, this excludes everything unless it has the label.

@asimpson
Copy link
Contributor Author

asimpson commented Nov 8, 2022

Sounds good! Can you add the updated instructions to the CONTRIBUTING file?

For sure, forgot we had one 😂

Copy link
Contributor

@andresmgot andresmgot left a comment

Choose a reason for hiding this comment

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

👍 thanks!

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