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

Add info on env variables for Formula Cookbook #5737

Merged
merged 3 commits into from
Feb 16, 2019

Conversation

davidjb
Copy link
Contributor

@davidjb davidjb commented Feb 15, 2019

This explains the levels of environment variable filtering present in Homebrew, explaining how and why variables without a HOMEBREW_ prefix or those which contain TOKEN etc are made unavailable to a Formula.

Previously, this behaviour was unclear (eg HOMEBREW_FOO works but HOMEBREW_TOKEN didn't) so I've added this documentation with references explaining the process. There may be other env filtering at work, but these are the two levels that were influencing my attempts to figure out why a third party formula written some time ago was no longer able to see its environment variable.

  • 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 tests with your changes locally?

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.

Great work here, thanks for the docs ❤️

This explains the levels of environment variable filtering present in Homebrew, explaining how and why variables without a `HOMEBREW_` prefix or those which contain `TOKEN` etc are made unavailable to a Formula.
@davidjb
Copy link
Contributor Author

davidjb commented Feb 15, 2019

@MikeMcQuaid PR updated with the changes, plus some improvements in readability for the rest.

@MikeMcQuaid MikeMcQuaid merged commit cadffcf into Homebrew:master Feb 16, 2019
@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, @davidjb!

@lock lock bot added the outdated PR was locked due to age label Mar 18, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Mar 18, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants