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

Bug: Check CHANGELOG updates before bumping version. #468

Open
ibgreen opened this issue Jul 30, 2024 · 3 comments
Open

Bug: Check CHANGELOG updates before bumping version. #468

ibgreen opened this issue Jul 30, 2024 · 3 comments

Comments

@ibgreen
Copy link
Collaborator

ibgreen commented Jul 30, 2024

  • When I try to publish in luma.gl, and ocular-dev-tools fails because it notices that there is no corresponding entry in CHANGELOG, the version is still bumped.
  • So after I fix the CHANGELOG and try publish again, ocular-dev-tools tries to publish as a version N+1.
  • Since I just added CHANGELOG entry for version N, but not version N+1, it fails again and bumps the version again.
@Pessimistress
Copy link
Collaborator

  1. Changelog enforcement is not defined in ocular-dev-tools
  2. You can simply reset all changes before publishing again

@ibgreen
Copy link
Collaborator Author

ibgreen commented Aug 1, 2024

Changelog enforcement is not defined in ocular-dev-tools

OK, then I not sure where it is enforced, see package.json. But it is notable that the changes are made and pushed before the CHANGELOG check fails, so in that case it seems that ocular-dev-tools invokes some other script that has the potential to fail after making the changes.

  "scripts": {
    "bootstrap": "ocular-bootstrap",
    "postinstall": "echo postinstall",
    "start": "open https://luma.gl/docs/getting-started",
    "clean": "ocular-clean",
    "build": "ocular-clean && (cd modules/constants && yarn pre-build) && ocular-build",
    "cover": "ocular-test cover",
    "lint": "ocular-lint",
    "publish-beta": "ocular-publish version-only-beta",
    "publish-prod": "ocular-publish version-only-prod",
    "version": "node scripts/verify-changelog.js && git add CHANGELOG.md",
    "test": "ocular-test",
    "test-ci": "ocular-lint && ocular-test node && ocular-test cover && yarn test-website",
    "test-fast": "ocular-test fast",
    "test-browser": "ocular-test browser",
    "test-browser-headless": "ocular-test browser-headless | tap-spec",
    "test-website": "cd website && yarn && yarn build && cd ..",
    "perf": "ocular-test perf-browser",
    "bench": "ocular-test bench",
    "bench-browser": "ocular-test bench-browser",
    "metrics": "./scripts/metrics.sh && ocular-metrics"

@ibgreen
Copy link
Collaborator Author

ibgreen commented Aug 1, 2024

You can simply reset all changes before publishing again

Well,

  • I don't know even what the specific changes are (tags etc) and all seems to have been pushed.
  • It is not like there is a dirty git state that I can just clear with something like git reset --hard

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

No branches or pull requests

2 participants