docs: Add redme
This commit is contained in:
parent
f7ba741940
commit
15c758cd63
39
README.md
Normal file
39
README.md
Normal file
@ -0,0 +1,39 @@
|
||||
### Example usage
|
||||
|
||||
```yaml
|
||||
jobs:
|
||||
release:
|
||||
name: Release
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write # to be able to publish a GitHub release
|
||||
issues: write # to be able to comment on released issues
|
||||
pull-requests: write # to be able to comment on released pull requests
|
||||
id-token: write # to enable use of OIDC for npm provenance
|
||||
steps:
|
||||
- name: Create Release
|
||||
uses: https://git.kjan.de/actions/semantic-release@main
|
||||
with:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||
```
|
||||
|
||||
### Also dont forget to add a config
|
||||
|
||||
release.config.cjs
|
||||
```
|
||||
module.exports = {
|
||||
|
||||
branches: ['main'],
|
||||
plugins: [
|
||||
'@semantic-release/commit-analyzer',
|
||||
'@semantic-release/release-notes-generator',
|
||||
'@semantic-release/changelog',
|
||||
["@saithodev/semantic-release-gitea", {
|
||||
"giteaUrl": "https://git.kjan.de"
|
||||
}],
|
||||
],
|
||||
};
|
||||
|
||||
|
||||
```
|
Loading…
Reference in New Issue
Block a user