You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+35-5
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,13 @@ Runs on `ubuntu` and `macos`.
8
8
9
9
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.
10
10
11
-
It is best to use this Action when a new tag is pushed:
11
+
> There are two ways to use this Action.
12
+
13
+
### Standard
14
+
15
+
Use if you want to simply bump the formula, when a new release happens.
16
+
17
+
Listen for new tags in workflow:
12
18
13
19
```yaml
14
20
on:
@@ -17,22 +23,46 @@ on:
17
23
- '*'
18
24
```
19
25
20
-
because then, the script will extract all needed informations by itself, you just need to specify the following step in your workflow:
26
+
The Action will extract all needed informations by itself, you just need to specify the following step in your workflow:
21
27
22
28
```yaml
23
29
- name: Update Homebrew formula
24
-
uses: dawidd6/action-homebrew-bump-formula@v2
30
+
uses: dawidd6/action-homebrew-bump-formula@v3
25
31
with:
26
32
# Github token, required, not the default one
27
33
token: ${{secrets.TOKEN}}
28
34
# Optional, defaults to homebrew/core
29
-
tap: dawidd6/tap
35
+
tap: REPO/NAME
30
36
# Formula name, generally required
31
37
formula: FORMULA
32
38
# Optional, will be determined automatically
33
39
tag: ${{github.ref}}
34
40
# Optional, will be determined automatically
35
41
revision: ${{github.sha}}
36
42
# Optional, if don't want to check for already open PRs
37
-
force: true
43
+
force: false #true
38
44
```
45
+
46
+
### Livecheck
47
+
48
+
If `livecheck` input is set to `true`, the Action will run `brew livecheck` to check if formula is outdated or if tap contains outdated formulae and then will run `brew bump-formula-pr` on those formulae with proper arguments to bump them.
49
+
50
+
Might be a good idea to run this on schedule.
51
+
52
+
If there are no outdated formulae, the Action will just exit.
53
+
54
+
```yaml
55
+
- name: Update Homebrew formula
56
+
uses: dawidd6/action-homebrew-bump-formula@v3
57
+
with:
58
+
# Github token, required, not the default one
59
+
token: ${{secrets.TOKEN}}
60
+
# Bump all outdated formulae in this tap
61
+
tap: dawidd6/tap
62
+
# Bump only this formula if outdated
63
+
formula: FORMULA
64
+
# Optional, if don't want to check for already open PRs
65
+
force: false # true
66
+
# Need to set this input if wants to use `brew livecheck`
0 commit comments