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

Fix update-changelog workflow to commit all updates #1449

Merged
merged 1 commit into from
May 22, 2024

Conversation

 brandonpayton
Copy link
Member

What is this PR doing?

This PR tweaks the update-changelog workflow so all relevant updates are commited.

What problem is it solving?

The previous version of the workflow didn't commit all changes and errored out due to a failed rebase.

How is the problem addressed?

By committing all expected changes:

  • CHANGELOG.md
  • packages/docs/site/docs/ changelog .md

The latter glob is there to hopefully avoid the need to tweak this workflow if the actual path, packages/docs/site/docs/17-changelog.md , changes numerically.

Testing Instructions

The real test is running the workflow on GitHub, but hopefully the following manual test is sufficient given the simplicity of the update.

Test the updated commit command:

  • cd to the project root
  • Make sure bun is available in your PATH.
  • Run npm run changelog -- --version=
  • Run bun packages/docs/site/bin/refresh-changelog.ts
  • Run git status and confirm CHANGELOG.md and packages/docs/site/docs/17-changelog.md have changes
  • Run the following command:
 git commit -m " TEST " \ CHANGELOG.md \ packages/docs/site/docs/ * changelog * .md
  • Run git status and confirm there are no uncommitted changes left
  • Run git log -n1 --name-status and confirm the expected changes were committed
  • Run git reset --hard HEAD~1 to dispose of the TEST commit

 @brandonpayton brandonpayton self-assigned this May 21, 2024
 @brandonpayton brandonpayton added [Type] Bug An existing feature does not function as intended [Type] Documentation Improvements or additions to documentation [Type] Repo / Project Management [Type] Developer Documentation Documentation for developers labels May 21, 2024
 @brandonpayton
Copy link
Member Author

😅 I think this PR description is way too long for such a simple, quick fix. Now there is nothing left but to bask in its glorious verbosity. 🫡

 @adamziel adamziel merged commit adb8d9b into trunk May 22, 2024
5 checks passed
 @adamziel adamziel deleted the include-all-changelog-changes-in-update branch May 22, 2024 03:03
Sign up for free to join this conversation on GitHub . Already have an account? Sign in to comment
Labels
[Type] Bug An existing feature does not function as intended [Type] Developer Documentation Documentation for developers [Type] Documentation Improvements or additions to documentation [Type] Repo / Project Management
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants