Skip to content

Commit 7e90328

Browse files
committed
docs(readme): update readme with new release information
1 parent 39d9386 commit 7e90328

File tree

1 file changed

+1
-19
lines changed

1 file changed

+1
-19
lines changed

README.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -110,25 +110,7 @@ committing it as a image.
110110

111111
## Releases
112112

113-
This project uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). This standardises commits so they can be used to generate changelogs. Use [standard-version](https://github.com/conventional-changelog/standard-version) to do a release (ensure you have no un-committed changes, I.e. a clean workspace).
114-
115-
- **Pre-release**:
116-
117-
A prerelease will update the version in the package.json to an appropriate semver version (based on whether the changes since the last tag are fixes, features and whether they contain breaking changes). In this case the `rc` tag is used in the semver string to mark it as a pre-release. It will then update the [CHANGELOG.md](CHANGELOG.md) file with the relevant changes since the last changelog update. These two changes are then committed with a standardised commit message. At this point, a tag is created with the same version number as the version field of the package.json. The second command then pushes both the new commit as well as the new tag.
118-
119-
```bash
120-
pnpm dlx standard-version --prerelease rc -t "''" --skip.changelog=true
121-
git push --follow-tags origin master
122-
```
123-
124-
- **Release**
125-
126-
This causes the same as above but as a normal release. I.e. no `rc` tag.
127-
128-
```bash
129-
pnpm dlx standard-version -t "''"
130-
git push --follow-tags origin master
131-
```
113+
This project uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). This standardises commits so they can be used to generate changelogs. Release PRs will be created by [Release Please](https://github.com/googleapis/release-please) based on the changes since the last release.
132114

133115
## Devcontainers
134116

0 commit comments

Comments
 (0)