Skip to content

Commit

Permalink
README: update
Browse files Browse the repository at this point in the history
  • Loading branch information
dawidd6 committed Apr 1, 2020
1 parent 4c9f995 commit 0fde40f
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ An action that wraps `brew bump-formula-pr` to ease the process of updating the

## Usage

One should use the [Personal Access Token](https://github.com/settings/tokens/new?scopes=public_repo) for `token` input to this Action, not the default `GITHUB_TOKEN`, because `brew bump-formula-pr` creates a fork of the formula's tap repository (if needed) and then creates a PR.
One should use the [Personal Access Token](https://github.com/settings/tokens/new?scopes=public_repo) for `token` input to this Action, not the default `GITHUB_TOKEN`, because `brew bump-formula-pr` creates a fork of the formula's tap repository (if needed) and then creates a pull request.

It is best to use this Action when a new tag is pushed:

Expand All @@ -22,9 +22,15 @@ because then, the script will extract all needed informations by itself, you jus
uses: dawidd6/action-homebrew-bump-formula@v2
with:
token: ${{secrets.TOKEN}}
# For example:
# dawidd6/tap/actions-updater
# or if the formula is in the core tap:
# lazygit
formula: USER/REPO/FORMULA
# Optional, will be determined automatically
tag: ${{github.ref}}
# Optional, will be determined automatically
revision: ${{github.sha}}
# Optional, if don't want to check for already open PRs
force: true
```
**note:** `USER/REPO/FORMULA` can be in the form that `brew install` would accept it. That is, for formula "baz" in foo's tap repo "homebrew-bar", one could use `foo/bar/baz` instead of `foo/homebrew-bar/baz`, but it is not necessary. This is because Homebrew expects tap names to have the `homebrew-` prefix.

0 comments on commit 0fde40f

Please sign in to comment.