Skip to content

Helper Presets

helpers:disableTypesNodeMajor

Disable major updates to @types/node.

{
  "packageRules": [
    {
      "enabled": false,
      "matchPackageNames": [
        "@types/node"
      ],
      "matchUpdateTypes": [
        "major"
      ]
    }
  ]
}

helpers:followTypescriptNext

Keep typescript version in sync with the next tag.

{
  "extends": [
    ":followTag(typescript, next)"
  ]
}

helpers:followTypescriptRc

Keep typescript version in sync with the rc tag.

{
  "extends": [
    ":followTag(typescript, rc)"
  ]
}

helpers:githubDigestChangelogs

Ensure that every dependency pinned by digest and sourced from GitHub.com contains a link to the commit-to-commit diff

{
  "packageRules": [
    {
      "changelogUrl": "{{sourceUrl}}/compare/{{currentDigest}}..{{newDigest}}",
      "matchSourceUrls": [
        "https://github.com/**"
      ],
      "matchUpdateTypes": [
        "digest"
      ]
    }
  ]
}

Correctly link to the source code for golang.org/x packages

{
  "packageRules": [
    {
      "matchManagers": [
        "gomod"
      ],
      "matchUpdateTypes": [
        "major",
        "minor",
        "patch"
      ],
      "prBodyDefinitions": {
        "Change": "{{#if (containsString depName 'golang.org/x/')}}[`{{{displayFrom}}}` -> `{{{displayTo}}}`](https://cs.opensource.google/{{{replace '^golang\\.org' 'go' depName}}}/+/refs/tags/{{{currentValue}}}...refs/tags/{{{newValue}}}){{else}}`{{{displayFrom}}}` -> `{{{displayTo}}}`{{/if}}"
      }
    }
  ]
}

Link to pkg.go.dev/... for golang.org/x packages' title

{
  "packageRules": [
    {
      "matchManagers": [
        "gomod"
      ],
      "prBodyDefinitions": {
        "Package": "{{#if (containsString depName 'golang.org/x/')}}[{{{depName}}}](https://pkg.go.dev/{{{depName}}}){{else}}{{{depNameLinked}}}{{/if}}"
      }
    }
  ]
}

helpers:pinGitHubActionDigests

Pin github-action digests.

{
  "packageRules": [
    {
      "matchDepTypes": [
        "action"
      ],
      "pinDigests": true
    }
  ]
}

helpers:pinGitHubActionDigestsToSemver

Convert pinned GitHub Action digests to SemVer.

{
  "packageRules": [
    {
      "extends": [
        "helpers:pinGitHubActionDigests"
      ],
      "extractVersion": "^(?<version>v?\\d+\\.\\d+\\.\\d+)$",
      "versioning": "regex:^v?(?<major>\\d+)(\\.(?<minor>\\d+)\\.(?<patch>\\d+))?$"
    }
  ]
}