From 0fde40fb795fe5731f6dd3c3488f1fd4fbb6e5e0 Mon Sep 17 00:00:00 2001 From: Dawid Dziurla Date: Wed, 1 Apr 2020 16:48:31 +0200 Subject: [PATCH] README: update --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 983e20f..5bdd3df 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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.