Skip to content

APM

Categories: no-category

Renovate supports updating APM dependencies.

File Matching

By default, Renovate will check any files matching the following regular expression: /(^|/)apm\.ya?ml$/.

For details on how to extend a manager's managerFilePatterns value, please follow this link.

Supported datasources

This manager supports extracting the following datasources: git-tags, github-tags, gitlab-tags.

Dependency types

This manager has no documented depType values.

Default config

{
  "managerFilePatterns": [
    "/(^|/)apm\\.ya?ml$/"
  ]
}

Lock File Maintenance

This manager supports lockFileMaintenance for the following file(s):

  • apm.lock.yaml

Lock file maintenance is delegated to the underlying package manager, which Renovate runs as an external command.

Additional Information

The apm manager keeps APM (Agent Package Manager) dependencies up to date.

Renovate reads the apm.yml manifest and updates the git-pinned entries under dependencies.apm and devDependencies.apm. Each entry uses the form [host/]owner/repo[/subpath]#<ref>, for example:

name: your-project
version: 1.0.0
dependencies:
  apm:
    - microsoft/apm-sample-package#v1.0.0
    - gitlab.com/team/project#v2.3.0
devDependencies:
  apm:
    - owner/repo#v1.2.3

Only entries that pin an exact #<ref> are updated. Entries without a #<ref> are skipped because there is no version to bump.

APM also documents pinning to a commit SHA with the release tag kept as a trailing comment (owner/repo#<sha> # v2.0.0). With pinDigests enabled (part of the config:best-practices preset) Renovate keeps both the SHA and the tag comment current, the same way it does for github-actions (uses: owner/action@<sha> # v4). A SHA pin without a tag comment is skipped, as there is no version to track.

When an apm.lock.yaml lockfile is present, Renovate refreshes it by running apm install after updating the manifest. This requires the apm CLI to be available (for example, with binarySource=global).