Skip to content

Commit 340f22e

Browse files
committed
Edit readme
1 parent f900b2f commit 340f22e

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,29 @@ Or `brew tap morpheus-lab/morpheus` and then `brew install <formula>`.
1010

1111
`brew help`, `man brew` or check [Homebrew's documentation](https://docs.brew.sh).
1212

13+
## Maintainer Guidelines
14+
1315
## Create Tap
1416

1517
brew tap-new morpheus-lab/morpheus
1618

17-
## Upload Bottles
19+
### To add a new formula for `foo` version `2.3.4` from `$URL`
20+
21+
* read [the Formula Cookbook](https://docs.brew.sh/Formula-Cookbook) or: `brew create $URL` and make edits
22+
* `brew install --build-from-source foo`
23+
* `brew audit --new-formula foo`
24+
* `git commit` with message formatted `foo 2.3.4 (new formula)`
25+
* [open a pull request](https://brew.sh/2020/11/18/homebrew-tap-with-bottles-uploaded-to-github-releases/) and fix any failing tests
26+
27+
### Publish Automatically Built Bottles
1828

1929
When a pull request making changes to a formula (or formulae) becomes green (all checks passed), then you can publish the built bottles. To do so, label your PR as `pr-pull` and the workflow will be triggered.
2030

21-
## GitHub Workflows
31+
### Get GitHub Workflows
2232

2333
The latest available GitHub workflows created with brew tap-new can be found under [`Homebrew/brew/Library/Homebrew/dev-cmd/tap-new.rb`](https://github.com/Homebrew/brew/blob/1a1aa3eed4ebda138f1f05806e957850c027eb4f/docs/Homebrew-homebrew-core-Maintainer-Guide.md).
2434

25-
## Maintainer Guidelines
26-
27-
### Locally Built Bottles
35+
### Add Locally Built Bottles
2836

2937
#### Generate Bottle
3038

0 commit comments

Comments
 (0)