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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add gh action to automate creation of changelog #33

Merged
merged 1 commit into from
Aug 31, 2022
Merged

Conversation

devisscher
Copy link
Contributor

@devisscher devisscher commented Aug 31, 2022

This PR adds a GH action, which checks for changesets when a new PR is created, then creates another PR that keeps track of changesets between versions.

We will follow a similar patter to Polaris, except this is a single package repo. So we won't need to differentiate releases for different packages.

This action for Changesets creates a pull request with all of the package versions updated and changelogs updated and when there are new changesets on your configured baseBranch, the PR will be updated. When you're ready, you can merge the pull request and you can either publish the packages to npm manually or setup the action to do it for you.

Once this is merged, we can move forward to automating the package release and possibly sending a slack message to a channel to alert of new versions 馃槃

@devisscher devisscher marked this pull request as ready for review August 31, 2022 19:12
@devisscher devisscher requested a review from a team August 31, 2022 19:12
ci: add empty changeset
@devisscher devisscher self-assigned this Aug 31, 2022
@devisscher devisscher changed the title Gh action Add gh action to automate creation of changelog Aug 31, 2022
@@ -0,0 +1,2 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

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

Haha what's this file for?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When creating a PR, we'd ask the contributor to create a change-set, explaining what they added to the code. If however, you want to create a PR which contains no changes worthy of a bump in version, you can use an empty change set to get CI passing.

Once this is merged, subsequent PR's will be checked for changesets, which will then update the "Version PR" that will be keeping track of changesets and updating the changelog. (This PR wouldn't be part of the changelog, because the changeset is empty)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You can also use 馃Skip Changelog to skip the check.

Copy link
Contributor

@carrotderek carrotderek left a comment

Choose a reason for hiding this comment

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

Changes looks good to me!

@devisscher devisscher merged commit 5e5ec16 into main Aug 31, 2022
@devisscher devisscher deleted the gh-action branch August 31, 2022 20:25
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

2 participants