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

Formula-Cookbook: update for Homebrew v4 #14740

Merged
merged 4 commits into from Feb 22, 2023

Conversation

unitof
Copy link
Contributor

@unitof unitof commented Feb 21, 2023

  • 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 Formula Cookbook includes some instructions which no longer work out of the box on Homebrew ≥4.0.0; this PR aims to update the documentation and correct the commands as necessary for local formulae development.

I don't believe any tests are necessary, but this is my first time contributing to docs so I could be wrong.

Fixes #14757

@request-info
Copy link

request-info bot commented Feb 21, 2023

Please provide a better issue/pull request title and/or description!

@request-info request-info bot added the needs response Needs a response from the issue/PR author label Feb 21, 2023
@unitof unitof changed the title Formulae-Cookbook: update for Homebrew v4 Formula-Cookbook: update for Homebrew v4 Feb 21, 2023
@unitof unitof marked this pull request as ready for review February 21, 2023 01:02
@gromgit
Copy link
Member

gromgit commented Feb 21, 2023

Suggest setting HOMEBREW_NO_INSTALL_FROM_API to 1 instead of 0, to be consistent with the manpage:

Note that environment variables must have a value set to be detected. For example, run export HOMEBREW_NO_INSECURE_REDIRECT=1 rather than just export HOMEBREW_NO_INSECURE_REDIRECT.

@unitof
Copy link
Contributor Author

unitof commented Feb 21, 2023

Suggest setting HOMEBREW_NO_INSTALL_FROM_API to 1 instead of 0, to be consistent with the manpage:

Note that environment variables must have a value set to be detected. For example, run export HOMEBREW_NO_INSECURE_REDIRECT=1 rather than just export HOMEBREW_NO_INSECURE_REDIRECT.

🤦🏻 thanks!

Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! Looking good so far, some wording tweaks, feel free to push back on any you disagree with and we can talk about them more.

docs/Formula-Cookbook.md Outdated Show resolved Hide resolved
docs/Formula-Cookbook.md Outdated Show resolved Hide resolved
docs/Formula-Cookbook.md Outdated Show resolved Hide resolved
docs/Formula-Cookbook.md Outdated Show resolved Hide resolved
@peterldowns
Copy link

This PR helped me work around a problem I had when creating a new formula. Looks like someone else had the same problem too. Linking this here in case it helps others.

Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
Copy link
Member

@Rylan12 Rylan12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @unitof, this looks great and is a huge improvement!

docs/Formula-Cookbook.md Outdated Show resolved Hide resolved
Co-authored-by: Eric Knibbe <enk3@outlook.com>
@slonopotamus
Copy link

Directly related: #14757. Possibly even this PR fixes #14757.

Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@MikeMcQuaid MikeMcQuaid merged commit 688d473 into Homebrew:master Feb 22, 2023
@github-actions github-actions bot added the outdated PR was locked due to age label Mar 25, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
needs response Needs a response from the issue/PR author outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unable to install locally-created formula
7 participants