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

Fix the error in Doc: How to Open a Homebrew Pull Request #17236

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ChenZhongPu
Copy link

The Doc How to Open a Homebrew Pull Request has some errors, which may mislead user contributors. To be specific,

  • --build-from-source is for formula only.
  • brew test is for formula only.

This pull request is to separate the tests for formulae/cask related changes.

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

- `--build-from-source` is for formula only.
- `brew test` is for formula only.
@apainintheneck apainintheneck added the documentation Documentation changes label May 14, 2024
Copy link
Contributor

@apainintheneck apainintheneck left a comment

Choose a reason for hiding this comment

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

You're right that the current documentation is a bit confusing and has errors. If possible, I think we should avoid having headings in bulleted lists though since that can make things a bit harder to follow and it seems like we're trying to avoid doing that in this doc.

I wonder if it would make sense to somehow split up the ## Create your pull request from a new branch heading so that we can provide specific formula, cask and main repository testing/auditing/linting instructions.

### Test your cask-related changes

```sh
HOMEBREW_NO_AUTO_UPDATE=1 HOMEBREW_NO_INSTALL_FROM_API=1 brew install <CHANGED_CASK>
Copy link
Contributor

Choose a reason for hiding this comment

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

Question: Why is HOMEBREW_NO_AUTO_UPDATE=1 needed now and only for cask-related changes?

Copy link
Author

Choose a reason for hiding this comment

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

It is to stop brew updating itself while installing a new cask or formula. This option makes sense for both cask and formula.

Copy link
Contributor

Choose a reason for hiding this comment

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

So the worry is that new changes might get pulled down from the remote tap that create conflicts with local formula/cask changes?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants