Skip to content

Commit

Permalink
docs: update latest usage
Browse files Browse the repository at this point in the history
  • Loading branch information
Xiphe committed Sep 6, 2022
1 parent d6709a0 commit af73ab1
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Automatically publish new versions and preview versions of pull requests to npm
## Use

```yml
# .github/workflows/release.yml
### .github/workflows/release.yml
name: Release

on:
Expand Down Expand Up @@ -51,17 +51,20 @@ jobs:
registry-url: "https://npm.pkg.github.com"
scope: "@songtradr"

# test, build, prepare here
### test, build, prepare here

############################################################
# All above is opinionated, all below is about this action #
############################################################

- name: 🚀 Publish
uses: songtradr/semantic-release-npm@v1
### All options are optional
with:
token: ${{ secrets.GITHUB_TOKEN }}

### npm token to authenticate against the registry (Default: ${{ github.token }})
npm_token: ${{ github.token }}
### GitHub PAT to create the release with (Default: ${{ github.token }})
gh_token: ${{ github.token }}
### The directory in which the release should be performed (Default: .)
directory: .
### Wether to publish preview releases for pull requests (Default: true)
Expand Down

0 comments on commit af73ab1

Please sign in to comment.