Skip to content

Commit d8a451d

Browse files
CopilotlukasmattaCopilot
authored
docs: Document versioning workflow and #SkipVersionBump mechanism in README (#515)
--------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: lukasmatta <4323927+lukasmatta@users.noreply.github.com> Co-authored-by: Lukáš Matta <lukasmatta@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent c29dc43 commit d8a451d

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,25 @@ Execute `npm run generate-json-api` to generate documentation for any changes in
9494

9595
See [playwright/README.md](playwright/README.md) for full details.
9696

97+
#### Versioning and publishing
98+
99+
The CI/CD pipeline automatically bumps the **minor version** and publishes the package to NPM on every push to `master` that either touches files under `projects/cps-ui-kit/**` or modifies `.github/workflows/cps-ui-kit-publish.yml`.
100+
101+
To publish a **major** or **patch** version instead:
102+
103+
1. Manually update the version in [`projects/cps-ui-kit/package.json`](projects/cps-ui-kit/package.json) to the desired version.
104+
2. Include `#SkipVersionBump` in the commit message so the pipeline skips the automatic minor bump and publishes exactly the version you set.
105+
106+
Example commit message for the **final/head commit in the push** (the workflow checks only `github.event.head_commit.message`, so `#SkipVersionBump` must appear in the last commit message; the token is matched against the full message, so placing it in the footer is preferred):
107+
108+
```
109+
chore: release patch fix
110+
111+
#SkipVersionBump
112+
```
113+
114+
> **Note:** Without `#SkipVersionBump`, any manual version change in `package.json` will be overwritten by the automatic minor bump before publishing.
115+
97116
#### Run accessibility tests
98117

99118
The project uses [pa11y-ci](https://github.com/pa11y/pa11y-ci) to test all components for WCAG 2.0 AA compliance.

0 commit comments

Comments
 (0)