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: document HOMEBREW_INSTALL_FROM_API usage in installation #13884

Merged
merged 3 commits into from Sep 18, 2022
Merged

docs: document HOMEBREW_INSTALL_FROM_API usage in installation #13884

merged 3 commits into from Sep 18, 2022

Conversation

kidonng
Copy link
Contributor

@kidonng kidonng commented Sep 18, 2022

  • 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?

This feature is added in Homebrew/install#628, but I forgot to document it here.

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.

Looks good! Some safety tweaks.

docs/Installation.md Outdated Show resolved Hide resolved
docs/Installation.md Outdated Show resolved Hide resolved
kidonng and others added 2 commits September 18, 2022 20:22
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
@MikeMcQuaid MikeMcQuaid merged commit 54f2f84 into Homebrew:master Sep 18, 2022
@MikeMcQuaid
Copy link
Member

Thanks again @kidonng!

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.

It's probably worth clarifying that you also need to set HOMEBREW_INSTALL_FROM_API in your shell profile file so it persists in new sessions. Otherwise, the next time you try to brew install in a new session, it will try to tap homebrew/core again then.

@kidonng
Copy link
Contributor Author

kidonng commented Sep 19, 2022

The "Git Remote Mirroring" section above does not emphasize this point, I'm just following suite. The install script does mention setting the remotes, perhaps this should be resolved there.

@github-actions github-actions bot added the outdated PR was locked due to age label Oct 20, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 20, 2022
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.

None yet

3 participants