Skip to content

docs: require a version bump for every feature and fix - #28

Merged
MatiasOS merged 1 commit into
openscan-explorer:mainfrom
MatiasOS:docs/require-version-bump
Sep 14, 2026
Merged

MatiasOS merged 1 commit into
openscan-explorer:mainfrom
MatiasOS:docs/require-version-bump

Conversation

@MatiasOS

Copy link
Copy Markdown
Member

Summary

Documents a versioning rule so a merged change can't silently skip publishing again, the way #26 did. The 1.8.0 bump that releases #26 is a separate PR (chore/release-1.8.0).

npm-publish.yml publishes on every push to main, but JS-DevTools/npm-publish skips a version npm already has without failing the run. A PR that ships code without a bump therefore releases nothing while the workflow stays green.

The rule

Every PR that adds functionality or resolves an issue bumps package.json in that same PR, following semver — when a PR mixes kinds of change, the highest level wins:

  • MAJOR — breaking change to the public API
  • MINOR — new functionality (feat)
  • PATCH — resolved issue (fix, perf, behaviour-changing refactor)

The bump is its own commit with the bare version as the subject (e.g. 1.8.1), made with npm version <level> --no-git-tag-version so package-lock.json stays in sync. PRs that change nothing under src/ — docs, tests, CI, tooling — are exempt.

Changes

  • CLAUDE.md: new Versioning section after CI/CD Pipeline, a note on the publish step's silent skip, and a pointer in Important Notes for AI Assistants
  • README.md: rule added to Version Management; the Manual Release and Automated Release steps now expect the bump to arrive with the PR

Documentation only — this adds no CI enforcement.

@MatiasOS
MatiasOS merged commit 6545324 into openscan-explorer:main Sep 14, 2026
1 of 2 checks passed
@MatiasOS
MatiasOS deleted the docs/require-version-bump branch September 14, 2026 20:31
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.

1 participant