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

Investigate homebrew formula best practices #385

Open
joe-stafford opened this issue Jan 19, 2024 · 1 comment
Open

Investigate homebrew formula best practices #385

joe-stafford opened this issue Jan 19, 2024 · 1 comment
Assignees
Labels
spike How do we build this?

Comments

@joe-stafford
Copy link
Contributor

As a Release Engineer I want to use best practices supported by the Homebrew community in constructing secureli's homebrew formula.

AC:

  • Report investigation findings as story comments
  • If best practice differs from current practice, create appropriate user stories
@joe-stafford joe-stafford added the spike How do we build this? label Jan 19, 2024
@shrutitirpude shrutitirpude self-assigned this Jun 20, 2024
@shrutitirpude
Copy link

shrutitirpude commented Jun 24, 2024

Notes from best practices in constructing homebrew formula :

  • The class name in the formula should start with caps i.e Secureli
  • Use the HTTPS URL for downloading the source tarball and specify the SHA256 checksum.
  • Use the install method to define the steps required to build and install the software
  • Write a test method
  • Includes the necessary Language::Python::Virtualenv module.
  • The url, version, and sha256 are correctly set, ensuring the source integrity.
  • Specifies dependencies on pre-commit and python@3.9, which are needed for the formula to work correctly.
  • The resources block is correctly defined, listing all the Python dependencies required for secureli.
  • virtualenv_install_with_resources, which is the recommended way to handle Python packages in Homebrew formulas.

The best practices are followed in the hombrew formula

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spike How do we build this?
Projects
Status: Done
Development

No branches or pull requests

2 participants