kubernetes
/
kops
mirror of https://github.com/kubernetes/kops.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update homebrew release docs. 

`brew bump-formula-pr` has simplified the process for updating brew
forumla
This commit is contained in:
Mike Splain 2017-10-10 13:25:34 -04:00
parent 7b65c5449d
commit b4de894ea8
1 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/development/homebrew.md
View File

@ -4,22 +4,37 @@ Submitting a new release of kops to Homebrew is very simple.
### From a homebrew machine
```brew edit kops``` will open an editor on your machine to edit the formula. Make the following changes:
`brew bump-formula-pr` makes it easy to update our homebrew formula.
This will automatically update the provided fields and open a PR for you.
More details on this script are located [here.](https://github.com/Homebrew/brew/blob/master/Library/Homebrew/dev-cmd/bump-formula-pr.rb)
Example usage:
```
brew bump-formula-pr \
--url=https://github.com/kubernetes/kops/archive/1.7.1.tar.gz \
--sha256=044c5c7a737ed3acf53517e64bb27d3da8f7517d2914df89efeeaf84bc8a722a
```
* Update the URL variable to the tar.gz of the new release source code
* Update the sha256 variable to SHA256 checksum of the new tar.gz
**If we change how dependencies work or if we make the install require something other than a simple make, we'll need to update the commands**
```brew edit kops``` will open an editor on your machine to edit the formula.
You can use this to make more in depth changes to the formula.
### Test that Homebrew formula works
```brew uninstall kops && brew install kops``` will install the new version. Test and make sure that the new release works.
```brew uninstall kops && brew install kops``` will install the new version.
Test and make sure that the new release works.
### Audit the Homebrew formula
```brew audit --strict --online``` will output any code that that doesn't meet the Homebrew standards.
### Send a commit to the Homebrew repo
Rather than repeating documentation that might change, head over to [Homebrew documentation](https://github.com/Homebrew/brew/blob/master/docs/Formula-Cookbook.md#commit) for directions and conventions.
Rather than repeating documentation that might change, head over to
[Homebrew documentation](https://github.com/Homebrew/brew/blob/master/docs/Formula-Cookbook.md#commit)
for directions and conventions.
The formula can be found in hacks/brew/kops.rb.