admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

docs: New linuxbrew + bump-formula-pr changes

Browse Source
This commit is contained in:
Jonathan Chang 2019-11-17 12:24:06 +11:00
parent ba3472b28c
commit 1f7d9e432c
1 changed files with 12 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/Homebrew-linuxbrew-core-Maintainer-Guide.md
View File

@ -267,8 +267,8 @@ HOMEBREW_BOTTLE_DOMAIN=https://linuxbrew.bintray.com brew pull --bottle --bintra
It saves a lot of time to alias this in your shell config. One It saves a lot of time to alias this in your shell config. One
possible alias is `lbrew-pull-bottle`. possible alias is `lbrew-pull-bottle`.
For PRs with the title "Build a bottle for Linuxbrew" and that have For PRs with the title "Build a bottle for Linux" and that have
only one commit with contents "# Build a bottle for Linuxbrew", these only one commit with contents "# Build a bottle for Linux", these
have been created with `brew build-bottle-pr` and the commit from the have been created with `brew build-bottle-pr` and the commit from the
PR doesn't need preserving. We don't want to litter the codebase with PR doesn't need preserving. We don't want to litter the codebase with
comments. In these cases, you can combine `brew pull --bottle` with comments. In these cases, you can combine `brew pull --bottle` with
@ -284,7 +284,7 @@ lbrew-pull-bottle <PR-NUMBER> && brew squash-bottle-pr
For PRs where there have been force pushes or extra commits to fix the For PRs where there have been force pushes or extra commits to fix the
build or fix bottling syntax, we can't `brew squash-bottle-pr` as we build or fix bottling syntax, we can't `brew squash-bottle-pr` as we
must keep the fixes. If the `# Build a bottle for Linuxbrew` line must keep the fixes. If the `# Build a bottle for Linux` line
still exists in the formula, remove it. still exists in the formula, remove it.
The `brew pull` command *publishes* the bottle to BinTray and verifies The `brew pull` command *publishes* the bottle to BinTray and verifies
@ -303,10 +303,10 @@ a list of who published what recently).
Once you've pushed to `origin`, there's no going back: you're a Once you've pushed to `origin`, there's no going back: you're a
maintainer now, you can't force-push to fix your mistakes! maintainer now, you can't force-push to fix your mistakes!
## Creating new Linux specific formula ## Creating new Linux-specific formula
Make a PR to `Homebrew/linuxbrew-core` containing one commit named like this: `name (new formula)`. Keep only one commit in this PR, squash and force push to your branch if needed. Include a comment: `# tag "linuxbrew"` in the formula after the `url` stanza, so maintainers can easily find Linux only formulae. Make a PR to `Homebrew/linuxbrew-core` containing one commit named like this: `name (new formula)`. Keep only one commit in this PR, squash and force push to your branch if needed. Include a comment: `# tag "linux"` in the formula after the `url` stanza, so maintainers can easily find Linux only formulae.
For `brew pull` to be successful when new formulae are added, we have to insert an empty bottle block into the formula code. This usually goes after the `linuxbrew` tag. For `brew pull` to be successful when new formulae are added, we have to insert an empty bottle block into the formula code. This usually goes after the `linux` tag.
```ruby ```ruby
bottle do bottle do
end end
@ -320,14 +320,11 @@ end
### Formulae that exist in Homebrew/homebrew-core ### Formulae that exist in Homebrew/homebrew-core
The `brew bump-formula-pr` command will raise PRs against the Linux When running on Linux, the `brew bump-formula-pr` command should raise pull
formula repo for upstream Mac formulae when running on Linux. This requests against the correct upstream macOS Homebrew-core repository. If a
isn't how version bumps are done for _most_ formulae. Until pull request is raised against the Linuxbrew-core repository when an upstream
[Homebrew/brew issue formula exists, please use the following message to direct users to the
6341](https://github.com/Homebrew/brew/issues/6341) is implemented - a correct repository:
feature that will raise PRs against the correct repo for macOS
formulae bumps on Linux - we have to redirect users to raise their PRs
in Homebrew/homebrew-core:
> Thanks for your PR. > Thanks for your PR.
> >
@ -338,7 +335,7 @@ in Homebrew/homebrew-core:
### Linux-only formulae ### Linux-only formulae
If the formula is a Linux-only formula, it either: If the formula is a Linux-only formula, it either:
- will contain the line `# tag "linuxbrew"` - will contain the line `# tag "linux"`
- won't have macOS bottles - won't have macOS bottles
These formulae are fine for users to bump with `brew bump-formula-pr`, These formulae are fine for users to bump with `brew bump-formula-pr`,