Precommit

kind: precommit

Description

The Precommit crawler looks recursively for all precommit repository updates.

It currently support the following sources:

Manifest

Parameters

NameTypeDescriptionRequired
digestbooleanDigest 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
ignorearrayIgnore allows to specify rule to ignore autodiscovery a specific NPM based on a rule
    pathstringPath specifies a .pre-commit-config.yaml path pattern, the pattern requires to match all of name, not just a substring.
    reposobjectRepos specifies the list of NPM packages to check
onlyarrayOnly allows to specify rule to only autodiscover manifest for a specific NPM based on a rule
    pathstringPath specifies a .pre-commit-config.yaml path pattern, the pattern requires to match all of name, not just a substring.
    reposobjectRepos specifies the list of NPM packages to check
rootdirstringRootDir defines the root directory used to recursively search for npm packages.json
versionfilterobject

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:
			`patch` - patch only update patch version
			`minor` - minor only update minor version
			`major` - major only update major versions
			`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.
    kindstringspecifies the version kind such as semver, regex, or latest
    patternstringspecifies 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
    regexstringspecifies the regex pattern, used for regex/semver and regex/time. Output of the first capture group will be used.
    strictbooleanstrict 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 →