Skip to content

Commit e3031fa

Browse files
committed
Document how to release
1 parent 3352042 commit e3031fa

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,26 @@ wp-env run cli "wp rewrite structure '/%postname%'"
1414
```
1515

1616
The site is now available at http://localhost:8888.
17+
18+
19+
## Release
20+
Plugin releases are automatically created through a GitHub Action, which is executed whenever a tag of the form `vX.Y.Z` is pushed. You can create and push a tag as follows.
21+
22+
First find the latest tag:
23+
24+
```shell
25+
# Fetch tags from origin
26+
git fetch
27+
28+
# Returns the latest tag, e.g. v0.1.0
29+
git describe --tags --abbrev=0
30+
```
31+
32+
Then create and push a tag that increments the latest one as per [Semantic Versioning](https://semver.org/):
33+
34+
```shell
35+
git tag v0.1.1
36+
git push origin v0.1.1
37+
```
38+
39+
The [GitHub Action](https://github.com/Automattic/wp-openid-connect-server/actions) will launch automatically, and when completed will have created a **draft release** for the tag that was pushed. You should then edit that release to provide a meaningful title and description (ideally including a [changelog](https://keepachangelog.com/en/1.0.0/)), then publish the release.

0 commit comments

Comments
 (0)