Precommit

kind: precommit

Description

The Precommit crawler looks recursively for all precommit repository updates.

It currently support the following sources:

Manifest

Parameters

Name Type Description Required
digest boolean Digest provides parameters to specify if the generated manifest should use a digest instead of the branch or tag. This is equivalent to using the --freeze option of precommit
ignore array Ignore allows to specify rule to ignore autodiscovery a specific NPM based on a rule
    path string Path specifies a .pre-commit-config.yaml path pattern, the pattern requires to match all of name, not just a substring.
    repos object Repos specifies the list of NPM packages to check
only array Only allows to specify rule to only autodiscover manifest for a specific NPM based on a rule
    path string Path specifies a .pre-commit-config.yaml path pattern, the pattern requires to match all of name, not just a substring.
    repos object Repos specifies the list of NPM packages to check
rootdir string RootDir defines the root directory used to recursively search for npm packages.json
versionfilter object

versionfilter provides parameters to specify the version pattern used when generating manifest.

kind - semver versionfilter of kind semver uses semantic versioning as version filtering pattern accepts one of: prerelease - Updatecli tries to identify the latest prerelease whatever it means patch - Updatecli only handles patch version update minor - Updatecli handles patch AND minor version update minoronly - Updatecli handles minor version only major - Updatecli handles patch, minor, AND major version update majoronly - Updatecli only handles major version update a version constraint such as >= 1.0.0

kind - regex versionfilter of kind regex uses regular expression as version filtering pattern accepts a valid regular expression

example:

  versionfilter:
    kind: semver
    pattern: minor

and its type like regex, semver, or just latest.

More examples can be found at https://www.updatecli.io/docs/core/versionfilter/
    kind string specifies the version kind such as semver, regex, or latest
    pattern string specifies the version pattern according the version kind for semver, it is a semver constraint for regex, it is a regex pattern for time, it is a date format
    regex string specifies the regex pattern, used for regex/semver and regex/time. Output of the first capture group will be used.
    replaceall object replaceAll applies a regex replacement to version strings before filtering. This is useful for transforming versions (e.g., curl-8_15_0 to curl-8.15.0) before regex extraction.
        pattern string Pattern specifies the regex pattern to match for replacement
        replacement string Replacement specifies the replacement string (supports $1, $2, etc. for captured groups)
    strict boolean strict enforce strict versioning rule. Only used for semantic versioning at this time
⚠ This table is generated from the Updatecli codebase and may contain inaccurate data. Feel free to report them on github.com/updatecli/updatecli

Example

# updatecli.d/default.yaml
name: "precommit autodiscovery"
scms:
  default:
    kind: git
    spec:
      url: https://github.com/updatecli/updatecli.git
      branch: "main"

autodiscovery:
  scmid: default
  crawlers:
    precommit:
      spec:
        digest: true
Last modified on May 2, 2025
Edit this page on GitHub
← NPM
Prow →