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

create: modify cask template #16345

Merged

Conversation

razvanazamfirei
Copy link
Member

@razvanazamfirei razvanazamfirei commented Dec 15, 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? improve docs for adding/updating casks/formula #16327
  • 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 PR does the following:

  • Modifies the cask template used for the create command
  • Rearranges the list of reasons for cask rejection to align with their observed frequency
  • Adds livecheck and zap to the list of required stanzas
  • Provides guidance for situations where a zap stanza is not necessary
  • Updates the example casks in the documentation to include ones containing all required stanzas

Closes #16342.

@razvanazamfirei
Copy link
Member Author

I would note that we currently don't include an explicit livecheck stanza for casks using the :Git strategy. I would argue that we modify the documentation regardless, and perhaps we can discuss whether we should use :Git explicitly and make it an audit.

Copy link
Contributor

@0xdevalias 0xdevalias left a comment

Choose a reason for hiding this comment

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

Some notes/suggestions/thoughts.


This PR does the following:

  • ..snip..
  • Adds livecheck and zap to the list of required stanzas

When I reviewed the code, I think this may have only been done in the docs, but not actually enforced in any of the code through brew style / brew audit / similar?

Library/Homebrew/dev-cmd/create.rb Show resolved Hide resolved
docs/Adding-Software-to-Homebrew.md Show resolved Hide resolved
docs/Adding-Software-to-Homebrew.md Show resolved Hide resolved
docs/Adding-Software-to-Homebrew.md Show resolved Hide resolved
docs/Cask-Cookbook.md Show resolved Hide resolved
docs/Cask-Cookbook.md Show resolved Hide resolved
docs/Acceptable-Casks.md Outdated Show resolved Hide resolved
docs/Acceptable-Casks.md Show resolved Hide resolved
docs/Acceptable-Casks.md Show resolved Hide resolved
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 as usual, thanks @razvanazamfirei!

Noticed one tiny bit of pedantry I'm committing and then will auto-merge.

docs/Acceptable-Casks.md Outdated Show resolved Hide resolved
@MikeMcQuaid
Copy link
Member

@0xdevalias please do not review any more PRs until you are a maintainer and focus on your own, thanks.

@MikeMcQuaid MikeMcQuaid merged commit 4776c19 into Homebrew:master Dec 17, 2023
24 checks passed
@razvanazamfirei razvanazamfirei deleted the update-cask-documentation branch December 19, 2023 15:29
@github-actions github-actions bot added the outdated PR was locked due to age label Jan 19, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 19, 2024
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.

Improve brew create --cask + related tools/docs to reduce friction/manual effort/prior knowledge required
3 participants