Skip to content

fix(renovate): generalize GitHub ref regex manager #873

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ReenigneArcher merged 1 commit into from
Sep 1, 2026
Merged

fix(renovate): generalize GitHub ref regex manager #873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions renovate-config.json5
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,17 +138,17 @@
},
],
"customManagers": [
// actionlint release and commit used by the common lint workflow.
// Annotated GitHub release, tag, or branch values paired with immutable commits.
{
"customType": "regex",
"description": "Update actionlint and its jsDelivr commit",
"description": "Update annotated GitHub values and their jsDelivr commits",
"managerFilePatterns": [
"/^\\.github/workflows/__call-common-lint[.]ya?ml$/",
"/^(?:\\.github/workflows/.*[.]ya?ml|actions/[^/]+/action[.]ya?ml)$/",
],
"matchStrings": [
"# renovate: datasource=(?<datasource>[a-zA-Z0-9-._]+?) depName=(?<depName>[^\\s]+?)\\s+actionlint_version=\\\"(?<currentValue>v?[0-9.]+)\\\"\\s+actionlint_ref=\\\"(?<currentDigest>[a-fA-F0-9]{40})\\\"",
"# renovate: datasource=(?<datasource>[a-zA-Z0-9-._]+?) depName=(?<depName>[^\\s]+?)(?:\\s+versioning=(?<versioning>[^\\s]+?))?\\s+[a-zA-Z0-9_]+?_(?:branch|release|tag|version)=\\\"(?<currentValue>[^\\\"\\s]+)\\\"\\s+[a-zA-Z0-9_]+?_ref=\\\"(?<currentDigest>[a-fA-F0-9]{40})\\\"",
],
"versioningTemplate": "semver",
"versioningTemplate": "{{#if versioning}}{{{versioning}}}{{else}}semver{{/if}}",
},
// cdnjs URLs in Jekyll config files, front matter, data YAML, and simple HTML attrs, with optional adjacent SRI hashes.
{
Expand Down
55 changes: 39 additions & 16 deletions tests/renovate-config.test.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ import {extractPackageFile as extractCdnUrlPackageFile} from 'renovate/dist/modu
import {extractPackageFile as extractRegexPackageFile} from 'renovate/dist/modules/manager/custom/regex/index.js';

const renovateConfig = JSON5.parse(fs.readFileSync('renovate-config.json5', 'utf8'));
const actionlintManager = renovateConfig.customManagers.find(
manager => manager.description === 'Update actionlint and its jsDelivr commit',
const githubRefManager = renovateConfig.customManagers.find(
manager => manager.description === 'Update annotated GitHub values and their jsDelivr commits',
);
const jekyllNpmCdnManager = renovateConfig.customManagers.find(
manager => manager.datasourceTemplate === 'npm'
Expand Down Expand Up @@ -39,24 +39,28 @@ function extractNpmDependencies(manager, fileName, content) {
return extractRegexPackageFile(content, fileName, manager)?.deps ?? [];
}

test('extracts the actionlint release and jsDelivr commit', () => {
const fileName = '.github/workflows/__call-common-lint.yml';
const content = fs.readFileSync(fileName, 'utf8');
assert.ok(actionlintManager, 'Expected to find the actionlint custom manager');
function extractGitHubRefDependencies(fileName, content) {
assert.ok(githubRefManager, 'Expected to find the annotated GitHub ref custom manager');
assert.ok(
matchesManagerFilePattern(fileName, actionlintManager.managerFilePatterns),
`Expected the actionlint manager to scan ${fileName}`,
matchesManagerFilePattern(fileName, githubRefManager.managerFilePatterns),
`Expected the annotated GitHub ref manager to scan ${fileName}`,
);

const dependencies = extractRegexPackageFile(content, fileName, actionlintManager)?.deps ?? [];
const dependencies = extractRegexPackageFile(content, fileName, githubRefManager)?.deps ?? [];
return dependencies.map(dependency => ({
currentDigest: dependency.currentDigest,
currentValue: dependency.currentValue,
datasource: dependency.datasource,
depName: dependency.depName,
versioning: dependency.versioning,
}));
}

test('extracts the actionlint release and jsDelivr commit', () => {
const fileName = '.github/workflows/__call-common-lint.yml';
const content = fs.readFileSync(fileName, 'utf8');
assert.deepEqual(
dependencies.map(dependency => ({
currentDigest: dependency.currentDigest,
currentValue: dependency.currentValue,
datasource: dependency.datasource,
depName: dependency.depName,
versioning: dependency.versioning,
})),
extractGitHubRefDependencies(fileName, content),
[{
currentDigest: '914e7df21a07ef503a81201c76d2b11c789d3fca',
currentValue: 'v1.7.12',
Expand All @@ -67,6 +71,25 @@ test('extracts the actionlint release and jsDelivr commit', () => {
);
});

test('extracts a GitHub branch and jsDelivr commit from a composite action', () => {
const fileName = 'actions/setup_python/action.yml';
const content = `
# renovate: datasource=github-digest depName=pyenv/pyenv-installer versioning=exact
pyenv_installer_branch="master"
pyenv_installer_ref="63a9e6a216796aeba2535a3bac8e79ba5d95166d"
`;
assert.deepEqual(
extractGitHubRefDependencies(fileName, content),
[{
currentDigest: '63a9e6a216796aeba2535a3bac8e79ba5d95166d',
currentValue: 'master',
datasource: 'github-digest',
depName: 'pyenv/pyenv-installer',
versioning: 'exact',
}],
);
});

function nextTestVersion(currentValue) {
const match = /^(.*?)(\d+)$/.exec(currentValue);
assert.ok(match, `Expected a version ending in a number: ${currentValue}`);
Expand Down