README
¶
brewer
CLI app to update Homebrew formulae.
Installation
To get the most up to date binaries, check the releases for the pre-built binary for your system.
You can also go get to install from source.
go get -u github.com/tombell/brewer/cmd/brewer
Usage
Use the -h/--help flag to see all the available flags when running brewer.
You will need a GitHub API token when running brewer. It's advised you create a token specifically for brewer.
You can update four different parts of a formula with brewer.
- the tag as part of the URL
:tag => "..."with--tag - the revision as part of the URL
:revision => "..."with--revision - the URL
url "..."with--url - the SHA256
sha256 "..."with--sha256
The path in the repository to the formula to update is passed as the --formula
flag.
You also have to specify the repository owner and name (the name defaults to
homebrew-formulae if omitted).
The commit message, author, and author's email must be given for the commit that updates the formula.
brewer --token $GITHUB_TOKEN \
--owner tombell \
--name homebrew-formulae \
--formula Formula/brewer.rb \
--tag v1.0.0 \
--revision beea04da6f030de641408ca265e31fb01e7dc22f \
--commit-message "Update Formula/brewer.rb to v1.0.0" \
--commit-author "Tom Bell" \
--commit-email "tomb@tomb.io"
This will pull down Formula/brewer.rb from the repository, and update the tag
and revision lines with v1.0.0 and beea04da6f030de641408ca265e31fb01e7dc22f.
With the commit message Update Formula/brewer.rb to v1.0.0, by Tom Bell.
Documentation
¶
Index ¶
- func Run(config Config) error
- type Config
- type Formula
- func (f *Formula) Revision() string
- func (f *Formula) SHA256() string
- func (f *Formula) Tag() string
- func (f *Formula) URL() string
- func (f *Formula) UpdateRevision(rev string) error
- func (f *Formula) UpdateSHA256(sha string) error
- func (f *Formula) UpdateTag(tag string) error
- func (f *Formula) UpdateURL(url string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Config ¶
type Config struct {
Token string
Owner string
Repo string
Path string
Tag string
Revision string
URL string
SHA256 string
CommitMessage string
CommitAuthor string
CommitEmail string
}
Config represents the command line flags passed into the Run function.
type Formula ¶
Formula represents a Homebrew formula that can be updated.
func (*Formula) Revision ¶
Revision returns the value for `:revision => "{{revision}}"` if the formula has one.
func (*Formula) SHA256 ¶
SHA256 returns the value for the `sha256 "{{sha}}"` if the formula has one.
func (*Formula) UpdateRevision ¶
UpdateRevision updates the `:revision => "{{revision}}"` part of a formula.
func (*Formula) UpdateSHA256 ¶
UpdateSHA256 updates the `sha256 "{{sha}}"` part of a formula.
Source Files
Directories