docs: Document versioning workflow and #SkipVersionBump mechanism in README#515
Merged
lukasmatta merged 5 commits intomasterfrom Apr 1, 2026
Merged
Conversation
Agent-Logs-Url: https://github.com/AbsaOSS/cps-shared-ui/sessions/3972851c-8ae7-490f-bda0-07dbb3c3fa91 Co-authored-by: lukasmatta <4323927+lukasmatta@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Document #SkipVersionBump mechanism and versioning workflow in README
docs: Document versioning workflow and #SkipVersionBump mechanism in README
Apr 1, 2026
lukasmatta
requested changes
Apr 1, 2026
Agent-Logs-Url: https://github.com/AbsaOSS/cps-shared-ui/sessions/5f996aaa-4d13-481e-b9f7-b323ed00220a Co-authored-by: lukasmatta <4323927+lukasmatta@users.noreply.github.com>
lukasmatta
requested review from
TerranceKhumalo-absa,
fateeand and
korel-san
as code owners
Coverage report for library
Test suite run success419 tests passing in 21 suites. Report generated by 🧪jest coverage report action from 9980977 |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation to the root README explaining the automated version bump + publish workflow for cps-ui-kit, including how contributors can bypass the default minor bump using #SkipVersionBump to publish a manually-set patch/major version.
Changes:
- Documented when the CI/CD pipeline auto-bumps the minor version and publishes to npm.
- Added instructions for publishing patch/major releases via manual
package.jsonversion changes +#SkipVersionBump. - Added an example commit message format and a note about manual version changes being overwritten without the token.
Playwright test results
Details
|
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
fateeand
approved these changes
Apr 1, 2026
lukasmatta
approved these changes
Apr 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The automatic minor-version bump and publish pipeline behavior was undocumented, leaving contributors unaware of how to control versioning or release major/patch versions.
Changes
mastertouchingprojects/cps-ui-kit/**#SkipVersionBumpin a commit message to bypass the auto-bump and publish a manually-set versionpackage.jsonversion changes are overwritten without#SkipVersionBumpExample commit message for a patch/major release: