Skip to content

docs: document the versioning / release-please convention #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PAMulligan merged 1 commit into from
May 31, 2026
Merged

docs: document the versioning / release-please convention #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,24 @@ PRs with invalid commit messages will fail the `commitlint` check.
See [docs/RELEASING.md](docs/RELEASING.md) for how these commits become tagged
releases.

## Versioning

The `version` field in `package.json` is intentionally pinned to `0.0.0` and is
**not** the repository version — **do not edit it by hand**. The source of truth
for the released version is the latest `vX.Y.Z` git tag together with
[`.release-please-manifest.json`](.release-please-manifest.json).

Versioning is automated by [release-please](https://github.com/googleapis/release-please).
The [Conventional Commit](#commit-message-format) types above drive the semver
bump; release-please opens a **Release PR** that updates the manifest and
`CHANGELOG.md`, and merging that PR creates the `vX.Y.Z` tag and GitHub Release.
Because the project uses release-please's `simple` release type, the bump is
recorded in `.release-please-manifest.json` rather than `package.json` — which
is exactly why `package.json` stays at `0.0.0`.

See [docs/RELEASING.md](docs/RELEASING.md) for the full flow, the version-bump
rules, and overrides (e.g. the `Release-As:` footer).

## Coding Standards

- Follow [WordPress PHP Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/)
Expand Down
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ Site at http://localhost:8080 · Admin at /wp-admin · Database UI at :8081.

**More docs:** [docs/QUICK-START.md](docs/QUICK-START.md) · [LOCAL-DEVELOPMENT.md](LOCAL-DEVELOPMENT.md) · [docs/docker-troubleshooting.md](docs/docker-troubleshooting.md)

> **Versioning:** `package.json` declares `0.0.0` on purpose — the real version lives in git tags + `.release-please-manifest.json`. See [Versioning](CONTRIBUTING.md#versioning) in CONTRIBUTING.md.

<details>
<summary>Alternative: use as a wp-content directory in an existing WordPress install</summary>

Expand Down
Loading