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

audit: check GitHub tags for prerelease status #8321

Merged
merged 3 commits into from Aug 13, 2020

Conversation

dtrodrigues
Copy link
Member

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

For GitHub formulae based on a tag vs a release, see if there is a corresponding release and if so, check to see if it's a prerelease.

$ brew audit --online cbmc
cbmc:
  * cbmc-5.12.6 is a GitHub prerelease
Error: 1 problem in 1 formula detected

@dtrodrigues dtrodrigues changed the title audit: check GitHub tags for pre-release status audit: check GitHub tags for prerelease status Aug 12, 2020
MikeMcQuaid
MikeMcQuaid previously approved these changes Aug 12, 2020
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.

Good catch 👏🏻. Could you let the relevant upstream(s) know that we're doing this to hopefully help them in future, too?

@dtrodrigues
Copy link
Member Author

The 5 affected formulae are

cbmc.rb
elm-format.rb
infrakit.rb
riff.rb
volta.rb

telegram-cli is also a GitHub prerelease based on a tag but is already in the allowlist and the one other formula on the allowlist is gitless.

I'll file an issue with the five above prior to merging this, but I'm wondering if we should contact the other two/get rid of the the allowlist for prerelease since Homebrew should be packaging/distributing stable software, and the GitHub prerelease tag implies that the tag is not ready for production:

To notify users that the release is not ready for production and may be unstable, select This is a pre-release.

https://docs.github.com/en/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release

@dtrodrigues
Copy link
Member Author

Previous discussion about prerelease: #7177
Previous discussion about prerelease allowlist: #7737

@dtrodrigues dtrodrigues added the discussion Input solicited from others label Aug 12, 2020
@dtrodrigues
Copy link
Member Author

In the short term, it might make the most sense to allow the current prerelease formula versions to remain and then have a conversation with the upstream projects when somebody tries to update the formula, so I added the few existing prerelease formulae to the allowlist and also added a check to ensure the formula version matches the allowlist version.

@MikeMcQuaid
Copy link
Member

In the short term, it might make the most sense to allow the current prerelease formula versions to remain and then have a conversation with the upstream projects when somebody tries to update the formula

Agreed 👍🏻. Great work @dtrodrigues!

@MikeMcQuaid MikeMcQuaid merged commit e2a2d79 into Homebrew:master Aug 13, 2020
@BrewTestBot BrewTestBot added the outdated PR was locked due to age label Dec 18, 2020
@Homebrew Homebrew locked as resolved and limited conversation to collaborators Dec 18, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
discussion Input solicited from others outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants