Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add license to block preceding revision placement #18247

Merged

Conversation

psibre
Copy link
Contributor

@psibre psibre commented Sep 4, 2024

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew typecheck with your changes locally?
  • Have you successfully run brew tests with your changes locally?

The documentation on revisions currently states that the revision "is inserted inserted underneath the homepage/url/sha256 block."

However, when I follow these instructions and add a revision to a formula, inserting it underneath the sha256 line (but above the license), the edited formula does not pass the audit:

$ brew audit --strict --online trivy
trivy
  * line 7, col 3: `license` (line 7) should be put before `revision` (line 6)
Error: 1 problem in 1 formula detected.

To clarify the relevant documentation, the license should be listed as part of the block beneath which the revision must be placed.

@MikeMcQuaid
Copy link
Member

Thanks so much for your first contribution! Without people like you submitting PRs we couldn't run this project. You rock, @psibre!

@carlocab carlocab merged commit 9659b57 into Homebrew:master Sep 4, 2024
27 checks passed
@psibre psibre deleted the revision-placement-instructions-update branch September 4, 2024 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants