Why does Autobump accept "draft" versions on GitHub?

[lelegard]

Hi,

Autobump is a great feature which makes a project's maintainer's life easier.

Is there some note on the precise way Autobump detects new releases of projects, depending on where they are hosted?

My project (tsduck) is hosted at GitHub and benefits from Autobump. Lately, I started a new automated release workflow. Instead of manually creating the release, everything is automated using GitHub Actions, all builds, full tests, release creation, binaries uploads. Because, my trust in automation is not as high as in humans, the release is created as "draft". When a GitHub release is marked as "draft", it does not appear as the "latest" official release. Thus, I keep the possibility of reviewing the whole thing and decide to manually mark the release as official and latest, or drop it entirely if anything does not look like perfect.

This workflow ran for the first time a week ago and I noticed that the project was immediately autobumped into HomeBrew, while it was created as a "draft" release.

By design, "draft" means not final, not approved, not yet at least. Do you think that Autodump should select them and publish them in HomeBrew? Because updated formulae are installed by everyone on Earth, wouldn't it be safer to only select official releases?

Note: the status of a release, draft vs. latest, is available through the GitHub API.

[carlocab]

Because we don't query the GitHub API unless we really need to (because of rate limits).

To make the formula check the GitHub API, it needs to specify the :github_latest strategy in a livecheck block.

[lelegard]

Hi @carlocab

Thank you for your answer. From the keywords you mention, I found this: https://docs.brew.sh/Brew-Livecheck

I have a few additional questions:

Does everything which is made for command brew livecheck also apply to autobump? Or, in other words, does autobump use brew livecheck?

Would the following block be sufficient to select the release which is marked as "latest"? Or shall I use a more complete block with a regex test on the tag name, as in the above mentioned page (which seems to be only an example)?

livecheck do
  strategy :github_latest
end

Where should the livecheck block be placed in the formula?

Is it acceptable to submit a PR on the formula with that modification only? So that the next version will be correctly selected.

[SMillerDev]

Or, in other words, does autobump use brew livecheck?

Yes it does

Would the following block be sufficient to select the release which is marked as "latest"?

Yeah, a regex is only necessary if other parts are ambiguous.

Where should the livecheck block be placed in the formula?

brew style will tell you, but it's below the block with the url.

Is it acceptable to submit a PR on the formula with that modification only?

Yeah, that's totally fine. It'll make sure that nobody needs to wait for a combined PR for the next version

[lelegard]

Thanks @so much

Would the following block be sufficient to select the release which is marked as "latest"?

Yeah, a regex is only necessary if other parts are ambiguous.

brew style gives this:

tsduck.rb:9:3: C: FormulaAudit/LivecheckUrlProvided: A url should be provided when regex or strategy are used.

I added url :stable in the livecheck block. I hope it is the right one.

[lelegard]

PR created here: Homebrew/homebrew-core#235893

Thank you @carlocab and @SMillerDev for your help.