Skip to content

Commit

Permalink
Merge pull request #16359 from x13a/docs-brew-audit-params
Browse files Browse the repository at this point in the history
update brew audit params in docs
  • Loading branch information
Rylan12 committed Dec 19, 2023
2 parents 5dac050 + 1ee012f commit 2aa78c9
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/Adding-Software-to-Homebrew.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ brew uninstall my-new-cask
If everything looks good, you鈥檒l also want to make sure your cask passes audit with:

```bash
brew audit --new-cask my-new-cask
brew audit --new --cask my-new-cask
```

You should also check stylistic details with `brew style`:
Expand Down
4 changes: 2 additions & 2 deletions docs/Formula-Cookbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Before submitting a new formula make sure your package:
* isn't already waiting to be merged (check the [issue tracker](https://github.com/Homebrew/homebrew-core/pulls))
* is still supported by upstream (i.e. doesn't require extensive patching)
* has a stable, tagged version (i.e. isn't just a GitHub repository with no versions)
* passes all `brew audit --new-formula <formula>` tests
* passes all `brew audit --new --formula <formula>` tests

Before submitting a new formula make sure you read over our [contribution guidelines](https://github.com/Homebrew/brew/blob/HEAD/CONTRIBUTING.md#contributing-to-homebrew).

Expand Down Expand Up @@ -366,7 +366,7 @@ Add aliases by creating symlinks in an `Aliases` directory in the tap root.

You can run `brew audit --strict --online` to test formulae for adherence to Homebrew house style, which is loosely based on the [Ruby Style Guide](https://github.com/rubocop-hq/ruby-style-guide#the-ruby-style-guide). The `audit` command includes warnings for trailing whitespace, preferred URLs for certain source hosts, and many other style issues. Fixing these warnings before committing will make the process a lot quicker for everyone.

New formulae being submitted to Homebrew should run `brew audit --new-formula foo`. This command is performed by Brew Test Bot on new submissions as part of the automated build and test process, and highlights more potential issues than the standard audit.
New formulae being submitted to Homebrew should run `brew audit --new --formula foo`. This command is performed by Brew Test Bot on new submissions as part of the automated build and test process, and highlights more potential issues than the standard audit.

Use `brew info` and check if the version guessed by Homebrew from the URL is correct. Add an explicit [`version`](https://rubydoc.brew.sh/Formula#version-class_method) if not.

Expand Down

0 comments on commit 2aa78c9

Please sign in to comment.