Proposal: Filter prek update candidates using GitHub release stability and immutability metadata

[pygarap]

Problem

prek update selects Git tags using timestamps and configurable tag filters, but cannot reliably determine whether a GitHub release is a prerelease or immutable.

Tag-name filtering requires manual patterns and cannot guarantee release stability or immutability.

Proposal

Add two optional settings under [update] to filter candidates using GitHub release metadata:

• exclude_prereleases = true: Skip releases where isPrerelease is true.
• require_immutable_releases = true: Skip releases where isImmutable is false.

These fields are exposed by gh release list --json. GitHub's REST API provides the equivalent fields as prerelease and immutable.

When enabled, consider only published GitHub releases satisfying the configured filters. Exclude tags without corresponding releases and preserve existing cooldown and tag filters.

Both settings should default to false to preserve current behavior.

Usage

prek.toml:

[update]
exclude_prereleases = true
require_immutable_releases = true

[[repos]]
repo = "https://github.com/example/hooks"
rev = "v1.0.0"
hooks = [{ id = "example-hook" }]

$ prek update

With these settings, prek update selects only GitHub releases where isPrerelease is false and isImmutable is true.

References

• feat: autoupdate fliter pre-release tags #174
• bug: prek update selects moving v1 tag instead of release tag for crate-ci/typos #2737
• Update configuration
• GitHub CLI release JSON fields
• GitHub Releases API