Formula Go assumes your software is hosted in GitHub, and the pre-compiled binaries are uploaded in the release page of it.
fgo [global options] command [arguments...] COMMANDS: init create Makefile and other related directories. build build binaries, upload them, and update the brew formula. update update the brew formula. help, h Shows a list of commands or help for one command GLOBAL OPTIONS: --pkg NAME, -p NAME directory NAME to store package files (default: "pkg") --brew NAME, -b NAME directory NAME to store homebrew formula (default: "homebrew") --help, -h show help --version, -v print the version
After starting your project, initialization is required. To initialize Formula Go, run
fgo init. It creates a Makefile, which will be used to compile your project, and a homebrew formula template.
To create the homebrew formula template, GitHub’s user name and repository name are required. By default, Formula Go checks your git configuration to get those information but you can given them by the arguments.
If your git configuration doesn’t have both information and you don’t give them as the arguments, this command will skip to create the template. In this case, you need to re-run init command after setting git configuration.
You can edit the Makefile and the template of homebrew formula, but build and release targets are necessary to run build command.
fgo build [version] runs build and release targets in the Makefile to build your software and upload the binary files to GitHub. This command takes an argument, version, which specifies the version to be created. If it is omitted, “snapshot” will be used and uploading will be skipped.
This command also updates the homebrew formula. After finishing this command, you need to push the updated formula.
This command takes the following option flags:
This flag specifies a GitHub API token used to upload binaries and create a release page. If this flag is not given but
GITHUB_TOKEN environment variable has been set, the environment variable will be used.
If neither this flag nor
GITHUB_TOKEN are given,
github.token variable in your
.gitconfig will be used.
This flag specifies a release note for the given version.
If this flag isn’t given but your
CHANGELOG.md contains a release note associated with that version, the release note will be used.
This flag specifies how many goroutines will be used to upload binaries. The default number is as same as the number of CPUs.
If this flag is set and there is a release for the given version, the release will be deleted and a new release for the given version will be created.
If this flag is set, the new release won’t be published and will be kept as a draft.
If this flag is set, the new release will be marked as a prerelease.
fgo update [version] updates the homebrew formula for a given version. build command updates the homebrew formula but sometimes you may need to re-update it to a specific version. This command do that.
$ brew tap jkawamoto/fgo $ brew install fgo
This software is released under the MIT License, see LICENSE.