Skip to content

test: update README and tests to use 'versionPrefix' instead of 'prefix'#50

Open
juancarlosjr97 wants to merge 1 commit intorelease-it:masterfrom
juancarlosjr97:docs/update-version-prefix
Open

test: update README and tests to use 'versionPrefix' instead of 'prefix'#50
juancarlosjr97 wants to merge 1 commit intorelease-it:masterfrom
juancarlosjr97:docs/update-version-prefix

Conversation

@juancarlosjr97
Copy link
Copy Markdown

@juancarlosjr97 juancarlosjr97 commented Apr 1, 2026

Closes #49

Summary

Updates documentation/tests to use versionPrefix instead of prefix.

Changes

  • README.md: update config example key from prefixversionPrefix.
  • test/json.test.js: update test title to reference versionPrefix.
  • test/general.test.js: clarify test title wording (preserve existing version-string prefix).

How to test

  • npm test

No runtime behavior changes expected (docs/tests only).

Copilot AI review requested due to automatic review settings April 1, 2026 16:31
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Aligns tests and README documentation with the actual @release-it/bumper configuration option name versionPrefix (instead of the outdated prefix), per Issue #49.

Changes:

  • Updated a README JSON config example to use versionPrefix.
  • Renamed test case descriptions to reference versionPrefix / clarify “prefix” behavior.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
test/json.test.js Updates a test name to explicitly reference versionPrefix.
test/general.test.js Clarifies a test name to describe preserving an existing version string prefix.
README.md Fixes the configuration example to use the correct versionPrefix key.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

Update documentation referencing version instead of versionPrefix

2 participants