Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Release

on:
push:
branches:
- main
- rc/*

permissions:
contents: write

jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: cycjimmy/semantic-release-action@v6.0.0
with:
extra_plugins: |
conventional-changelog-conventionalcommits
@semantic-release/exec
env:
FORCE_COLOR: 1
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
GITHUB_TOKEN: ${{ github.token }}
24 changes: 24 additions & 0 deletions .releaserc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
plugins:
- - '@semantic-release/commit-analyzer'
- preset: 'conventionalcommits'
- - '@semantic-release/release-notes-generator'
- preset: 'conventionalcommits'
- - '@semantic-release/github'
- successCommentCondition: false

# Update dist, in case Dependabot PRs merged without doing so
- - '@semantic-release/exec'
- prepareCmd: 'yarn install && yarn run build'

- - '@semantic-release/git'
- assets:
- 'dist/**'
- 'package.json' # commit updated version back to source
message: 'chore(release): update dist and package.json'

- '@semantic-release/npm'

branches:
- main
- name: rc/*
prerelease: '${name.replace(/^rc\//, "rc-")}'
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,7 @@ export function StoreContainer(): React.Node {
)
}
```

## Release

See [RELEASE.md](./RELEASE.md).
14 changes: 14 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Release

This project uses [semantic-release](https://github.com/semantic-release/semantic-release)
with [conventional commits](https://www.conventionalcommits.org/) to trigger releases.

To trigger a release in this project, merge a commit to `main` prefixed with:

1. `fix:` to trigger a patch release,
2. `feat:` to trigger minor, or
3. Use `<type>!:` or the `BREAKING CHANGES: <change>` footer to trigger major

Pre-releases can be made by pushing to an `rc/*` branch.

For more details, see the [Semantic Release](https://illuminate.atlassian.net/wiki/spaces/PENG/pages/17952735277/Semantic+Release) documentation.
Loading