Skip to content

Commit

Permalink
ci: release workflow and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
recanman committed May 25, 2024
1 parent 69b9a6f commit b6a1c60
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ jobs:
uses: stefanzweifel/git-auto-commit-action@v4
with:
branch: main
commit_message: 'docs: update CHANGELOG.md for ${{ github.ref_name }} [skip ci]'
commit_message: 'chore(release): v${{ github.ref_name }} [skip ci]'
file_pattern: CHANGELOG.md
23 changes: 23 additions & 0 deletions PUBLISHING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Publishing a release

This document describes the process of publishing a new version of the package.

1. Update the version in the `composer.json` file.
2. Commit the changes.
- ```bash
git commit -m "chore: bump version to <version>"
```

Where `<version>` is the new version number (e.g. `1.2.3`).
3. Create a new tag.
- ```bash
git tag v<version>
```

Where `<version>` is the new version number (e.g. `1.2.3`).
4. Push the changes.
- ```bash
git push origin master --tags
```

A release will automatically be created.

0 comments on commit b6a1c60

Please sign in to comment.