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

Incorrect commit recorded for dependent bumps in CHANGELOG.json #901

Open
ecraig12345 opened this issue Jul 22, 2023 · 1 comment
Open
Labels
bug Something isn't working

Comments

@ecraig12345
Copy link
Member

ecraig12345 commented Jul 22, 2023

Consider the following scenario:

  • Local package foo depends on local package bar
  • Changes are made to bar and a change file is generated
  • On publish, foo will also be bumped
  • foo's CHANGELOG.json will contain a comment for "Bump bar to vX.Y.Z". What commit hash is recorded in the changelog entry for this bump?
    • Expected: The publish commit (...which hasn't been created yet when the changelog is updated)
    • Actual: The commit prior to the publish commit

The only ways I can think of to solve this:

  • Have beachball make two commits: one for version bumps and one for changelog updates
  • Make the commit hash optional in the changelog comment
@ecraig12345
Copy link
Member Author

As an incremental improvement, #903 switches to recording "not available" as the commit, so at least we're not recording incorrect info.

@ecraig12345 ecraig12345 added the bug Something isn't working label Aug 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant