Skip to content
38 changes: 38 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Release

on:
push:
branches:
- main

concurrency: ${{ github.workflow }}-${{ github.ref }}

permissions:
contents: write
pull-requests: write
id-token: write

jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version-file: '.nvmrc'

- name: Install Dependencies
run: npm ci

- name: Create Release Pull Request or Publish to npm
id: changesets
uses: changesets/action@v1
with:
publish: npm run release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,13 @@ A simple component that renders "Hello World".
```tsx
<Mcu />
```

## Contributing

When submitting a pull request, please include a changeset to document your changes:

```bash
npx changeset
```

This helps us maintain the changelog and version the package appropriately.
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
"format": "prettier --write .",
"check-format": "prettier --check .",
"check-exports": "attw --pack . --ignore-rules cjs-resolves-to-esm no-resolution",
"release": "npm run build && changeset publish",
"local-release": "npm run ci && changeset version && changeset publish"
},
"peerDependencies": {
Expand Down