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

Update docs, removing brew --devel

This commit is contained in:
mikesplain 2018-11-27 10:25:44 -05:00
parent 0c8e5579f2
commit 72b331ca44
1 changed files with 13 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/development/homebrew.md
View File

@ -5,20 +5,20 @@ Homebrew makes installing kops [very simple for MacOS.](../install.md)
brew update && brew install kops brew update && brew install kops
``` ```
Development Releases and master can also be installed via Homebrew very easily: Master can also be installed via Homebrew very easily:
```bash ```bash
# Development Release
brew update && brew install kops --devel
# HEAD of master # HEAD of master
brew update && brew install kops --HEAD brew update && brew install kops --HEAD
``` ```
Note: if you already have kops installed, you need to substitute `upgrade` for `install`. Previously we could also ship development updates to homebrew but their [policy has changed.](https://github.com/Homebrew/brew/pull/5060#issuecomment-428149176)
You can switch between development and stable releases with: Note: if you already have kops installed, you need to substitute `upgrade` for `install`.
You can switch between installed releases with:
```bash ```bash
brew switch kops 1.7.1 brew switch kops 1.9.0
brew switch kops 1.8.0-beta.1 brew switch kops 1.10.0
``` ```
# Releasing kops to Brew # Releasing kops to Brew
@ -27,24 +27,15 @@ Submitting a new release of kops to Homebrew is very simple.
### From a homebrew machine ### From a homebrew machine
`brew bump-formula-pr` makes it easy to update our homebrew formula. `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. 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) More details on this script are located [here.](https://github.com/Homebrew/brew/blob/master/Library/Homebrew/dev-cmd/bump-formula-pr.rb)
We now include both major and development releases in homebrew. A development version can be updated by adding the `--devel` flag.
Example usage: Example usage:
```bash ```bash
# Major Version
brew bump-formula-pr kops \ brew bump-formula-pr kops \
--url=https://github.com/kubernetes/kops/archive/1.7.1.tar.gz \ --url=https://github.com/kubernetes/kops/archive/1.7.1.tar.gz \
--sha256=044c5c7a737ed3acf53517e64bb27d3da8f7517d2914df89efeeaf84bc8a722a --sha256=044c5c7a737ed3acf53517e64bb27d3da8f7517d2914df89efeeaf84bc8a722a
# Development Version
brew bump-formula-pr kops \
--devel \
--url=https://github.com/kubernetes/kops/archive/1.8.0-beta.1.tar.gz \
--sha256=81026d6c1cd7b3898a88275538a7842b4bd8387775937e0528ccb7b83948abf1
``` ```
* Update the URL variable to the tar.gz of the new release source code * Update the URL variable to the tar.gz of the new release source code
@ -52,11 +43,11 @@ brew bump-formula-pr kops \
**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** **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. ```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. You can use this to make more in depth changes to the formula.
### Test that Homebrew formula works ### Test that Homebrew formula works
```brew uninstall kops && brew install kops``` will install the new version. ```brew uninstall kops && brew install kops``` will install the new version.
Test and make sure that the new release works. Test and make sure that the new release works.
### Audit the Homebrew formula ### Audit the Homebrew formula
@ -64,8 +55,8 @@ Test and make sure that the new release works.
### Send a commit to the Homebrew repo ### Send a commit to the Homebrew repo
Rather than repeating documentation that might change, head over to Rather than repeating documentation that might change, head over to
[Homebrew documentation](https://github.com/Homebrew/brew/blob/master/docs/Formula-Cookbook.md#commit) [Homebrew documentation](https://github.com/Homebrew/brew/blob/master/docs/Formula-Cookbook.md#commit)
for directions and conventions. for directions and conventions.