-
Notifications
You must be signed in to change notification settings - Fork 496
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
Forcing preferred changelog format #173
Conversation
|
.changeset/changelog-config.js
Outdated
@@ -1,3 +1,5 @@ | |||
// Doesn't fully work but '.github/scripts/overwrite_changeset_changelog.py' forces the changelog to be formatted in GHA |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we just remove it if it doesn't work?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it half works, so it's already giving me an easier format to overwrite than the standard changeset
format from roo-node-types
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we remove the getReleaseSummary
function then? That doesn't work right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
removed 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also starting to wonder if this is worth the complexity. What is our current workflow now? Do we manually edit the file?
I think it is, we'll need less manual edits if we just click merge |
also, is ready to merge and wasn't that complex |
the current workfow is manually running git pull & checkout into the changeset branch, updating the CHANGELOG file with the proper format, running git add, git commit, git push, and then clicking merge, I think is worth it to reduce all of that to just clicking merge |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left 1 comment about removing the things that are not working in .changeset/changelog-config.js
- mainly to make it super obvious about what is working and what is not working.
Looks good otherwise 🙌
For what it's worth I just do an edit to add a new commit to the changeset PR using the github website editing tool, but it's annoying to do that and then wait for CI to run again before merging. |
Description
Forcing preferred changelog format
changeset
file is mergedchangeset-release.yml
will run and create aChangeset version bump
PR, only the jobchangeset-pr-version-bump
runschangeset-release.yml
again but now onlychangeset-pr-approve-merge
runs but doesn't run the lastAuto approve PR
step, it however updates theCHANGELOG.md
file with our preferred format and pushes to theChangeset version bump
, and then labels itchangelog-ready
changeset-release.yml
again and runs only theAuto approve PR
stepchangeset
PR,marketplace-publish.yml
is triggeredType of change
How Has This Been Tested?
Running the python script locally and printing the formatted changes on the
CHANGELOG.md
fileChecklist:
Additional context
Related Issues
Reviewers
Important
Automates changelog formatting and approval process using a Python script and GitHub Actions workflow.
overwrite_changeset_changelog.py
now reformats existing changelog content if no new content is provided.changeset-release.yml
automates changelog formatting and labeling.getReleaseSummary
function fromchangelog-config.js
.This description was created by
for bbf7ba7. It will automatically update as commits are pushed.