Versioning & Publishing

1. Authenticate with npm

Log in to npm from your terminal:

npm login

This authenticates the npm CLI and stores your credentials securely. Alternatively, for CI or automated publishing, provide an auth token via the NPM_TOKEN environment variable (e.g. //registry.npmjs.org/:_authToken=${NPM_TOKEN} in ~/.npmrc). Never commit auth tokens to this repository.

After entering your credentials, verify your login status:

npm whoami

This should display your username. If you’re not recognized, repeat the npm login step or check your credentials.

2. Determine the Version Bump

We follow Semantic Versioning. Here’s the convention for deciding which part of the version number to increment:

• Patch: For small corrections and bug fixes (no changes to the data structure or feature set).
• Minor: For adding new fixtures or functionality (in a backward-compatible manner).
• Major: For any breaking changes to the data structure or how consumers use this library. Use the appropriate command to bump the version:

# For a patch release (e.g., 1.0.0 → 1.0.1):
npm run bump:patch

# For a minor release (e.g., 1.0.1 → 1.1.0):
npm run bump:minor

# For a major release (e.g., 1.1.0 → 2.0.0):
npm run bump:major

This will automatically update your package.json, create a Git commit, and tag it with the new version.

3. Push Your Changes and Tags

If the version command didn’t automatically push your commit and tag, do so now:

git push

4. Publish to npm

Finally, publish your changes. If your package is scoped and intended to be publicly available, use:

npm run package 

5. Verify

Check the published version on npm:

npm info @chauvet/connect-base-profiles

You should see the newly published version in the output. If everything looks good, your updated package is now available for others to install.

6. update the package where it is being used

npm run update-base-profiles

this will update the package in the project where it is being used.