Skip to content

refactor(github-actions): simplify community action schema #42778

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
jamietanna merged 3 commits into from
Apr 21, 2026
+76 −187
Merged

refactor(github-actions): simplify community action schema #42778

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
20c4c91
refactor(github-actions): simplify comunity action schema
viceice Apr 21, 2026
042105e
refactor rename function
viceice Apr 21, 2026
6424268
refactor: rename and remove default versionings
viceice Apr 21, 2026
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
244 changes: 75 additions & 169 deletions lib/modules/manager/github-actions/community.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { z } from 'zod/v3';

import type { SkipReason, StageName } from '../../../types/index.ts';
import { escapeRegExp, regEx } from '../../../util/regex.ts';
import { DockerDatasource } from '../../datasource/docker/index.ts';
import { GithubReleasesDatasource } from '../../datasource/github-releases/index.ts';
Expand All @@ -9,42 +8,51 @@ import { PypiDatasource } from '../../datasource/pypi/index.ts';
import { RubyVersionDatasource } from '../../datasource/ruby-version/index.ts';
import * as condaVersioning from '../../versioning/conda/index.ts';
import * as npmVersioning from '../../versioning/npm/index.ts';
import * as pep440versioning from '../../versioning/pep440/index.ts';
import * as rubyVersioning from '../../versioning/ruby/index.ts';
import type { PackageDependency } from '../types.ts';

function matchAction(action: string): z.Schema {
function matchAction(action: string): z.ZodString {
return z
.string()
.regex(regEx(`(?:https?://[^/]+/)?${escapeRegExp(action)}(?:@.+)?$`));
}

function parseValue(
currentValue: string | undefined,
validator?: () => boolean,
): PackageDependency {
if (!currentValue) {
return {
skipStage: 'extract',
skipReason: 'unspecified-version',
depType: 'uses-with',
};
}
if (validator?.() === true) {
return {
skipStage: 'extract',
skipReason: 'invalid-version',
depType: 'uses-with',
currentValue,
};
}
return { currentValue, depType: 'uses-with' };
}

const SetupUV = z
.object({
// https://github.com/astral-sh/setup-uv
uses: matchAction('astral-sh/setup-uv'),
with: z.object({ version: z.string().optional() }),
})
.transform(({ with: val }): PackageDependency => {
let skipStage: StageName | undefined;
let skipReason: SkipReason | undefined;

if (!val.version) {
skipStage = 'extract';
skipReason = 'unspecified-version';
}

return {
.transform(
({ with: val }): PackageDependency => ({
datasource: GithubReleasesDatasource.id,
depName: 'astral-sh/uv',
versioning: npmVersioning.id,
packageName: 'astral-sh/uv',
...(skipStage && { skipStage }),
...(skipReason && { skipReason }),
currentValue: val.version,
depType: 'uses-with',
};
});
...parseValue(val.version),
}),
);

const SetupPnpm = z
.object({
Expand All @@ -53,25 +61,14 @@ const SetupPnpm = z
version: z.string().optional(),
}),
})
.transform(({ with: val }): PackageDependency => {
let skipStage: StageName | undefined;
let skipReason: SkipReason | undefined;
if (!val.version) {
skipStage = 'extract';
skipReason = 'unspecified-version';
}

return {
.transform(
({ with: val }): PackageDependency => ({
datasource: NpmDatasource.id,
depName: 'pnpm',
versioning: npmVersioning.id,
Comment thread
jamietanna marked this conversation as resolved.
packageName: 'pnpm',
...(skipStage && { skipStage }),
...(skipReason && { skipReason }),
currentValue: val.version,
depType: 'uses-with',
};
});
...parseValue(val.version),
}),
);

const SetupBun = z
.object({
Expand All @@ -80,25 +77,14 @@ const SetupBun = z
'bun-version': z.string().optional(),
}),
})
.transform(({ with: val }): PackageDependency => {
let skipStage: StageName | undefined;
let skipReason: SkipReason | undefined;
if (!val['bun-version']) {
skipStage = 'extract';
skipReason = 'unspecified-version';
}

return {
.transform(
({ with: val }): PackageDependency => ({
datasource: NpmDatasource.id,
depName: 'bun',
versioning: npmVersioning.id,
packageName: 'bun',
...(skipStage && { skipStage }),
...(skipReason && { skipReason }),
currentValue: val['bun-version'],
depType: 'uses-with',
};
});
...parseValue(val['bun-version']),
}),
);

const SetupDeno = z
.object({
Expand All @@ -107,25 +93,14 @@ const SetupDeno = z
'deno-version': z.string().optional(),
}),
})
.transform(({ with: val }): PackageDependency => {
let skipStage: StageName | undefined;
let skipReason: SkipReason | undefined;
if (!val['deno-version']) {
skipStage = 'extract';
skipReason = 'unspecified-version';
}

return {
.transform(
({ with: val }): PackageDependency => ({
datasource: NpmDatasource.id,
depName: 'deno',
versioning: npmVersioning.id,
packageName: 'deno',
...(skipStage && { skipStage }),
...(skipReason && { skipReason }),
currentValue: val['deno-version'],
depType: 'uses-with',
};
});
...parseValue(val['deno-version']),
}),
);

const SetupRuby = z
.object({
Expand All @@ -134,50 +109,28 @@ const SetupRuby = z
'ruby-version': z.string().optional(),
}),
})
.transform(({ with: val }): PackageDependency => {
let skipStage: StageName | undefined;
let skipReason: SkipReason | undefined;
if (!val['ruby-version']) {
skipStage = 'extract';
skipReason = 'unspecified-version';
}

return {
.transform(
({ with: val }): PackageDependency => ({
datasource: RubyVersionDatasource.id,
depName: 'ruby',
versioning: rubyVersioning.id,
packageName: 'ruby',
...(skipStage && { skipStage }),
...(skipReason && { skipReason }),
currentValue: val['ruby-version'],
depType: 'uses-with',
};
});
...parseValue(val['ruby-version']),
}),
);

const SetupPDM = z
.object({
uses: matchAction('pdm-project/setup-pdm'),
with: z.object({ version: z.string().optional() }),
})
.transform(({ with: val }): PackageDependency => {
let skipStage: StageName | undefined;
let skipReason: SkipReason | undefined;
if (!val.version) {
skipStage = 'extract';
skipReason = 'unspecified-version';
}

return {
.transform(
({ with: val }): PackageDependency => ({
datasource: PypiDatasource.id,
depName: 'pdm',
versioning: pep440versioning.id,
packageName: 'pdm',
currentValue: val.version,
...(skipStage && { skipStage }),
...(skipReason && { skipReason }),
depType: 'uses-with',
};
});
...parseValue(val.version),
}),
);

const InstallBinary = z
.object({
Expand All @@ -192,8 +145,7 @@ const InstallBinary = z
datasource: GithubReleasesDatasource.id,
depName: val.repo,
packageName: val.repo,
currentValue: val.tag,
depType: 'uses-with',
...parseValue(val.tag),
};
});

Expand All @@ -208,8 +160,7 @@ const SetupPixi = z
versioning: condaVersioning.id,
depName: 'prefix-dev/pixi',
packageName: 'prefix-dev/pixi',
currentValue: val['pixi-version'],
depType: 'uses-with',
...parseValue(val['pixi-version']),
};
});

Expand All @@ -219,103 +170,58 @@ const SetupHatch = z
uses: matchAction('pypa/hatch'),
with: z.object({ version: z.string().optional() }),
})
.transform(({ with: val }): PackageDependency => {
let skipStage: StageName | undefined;
let skipReason: SkipReason | undefined;

if (!val.version) {
skipStage = 'extract';
skipReason = 'unspecified-version';
}

return {
.transform(
({ with: val }): PackageDependency => ({
datasource: GithubReleasesDatasource.id,
depName: 'pypa/hatch',
packageName: 'pypa/hatch',
...(skipStage && { skipStage }),
...(skipReason && { skipReason }),
currentValue: val.version,
depType: 'uses-with',
...parseValue(val.version),
// Strip hatch- prefix from release tags
extractVersion: '^hatch-(?<version>.+)$',
};
});
}),
);

const SetupGolangciLint = z
.object({
uses: matchAction('golangci/golangci-lint-action'),
with: z.object({ version: z.string().optional() }),
})
.transform(({ with: val }): PackageDependency => {
let skipStage: StageName | undefined;
let skipReason: SkipReason | undefined;

if (!val.version) {
skipStage = 'extract';
skipReason = 'unspecified-version';
}

return {
.transform(
({ with: val }): PackageDependency => ({
datasource: GithubReleasesDatasource.id,
depName: 'golangci/golangci-lint',
packageName: 'golangci/golangci-lint',
...(skipStage && { skipStage }),
...(skipReason && { skipReason }),
currentValue: val.version,
depType: 'uses-with',
};
});
...parseValue(val.version),
}),
);

const ZizmorcoreZizmorAction = z
.object({
uses: matchAction('zizmorcore/zizmor-action'),
with: z.object({ version: z.string().optional() }),
})
.transform(({ with: val }): PackageDependency => {
let skipStage: StageName | undefined;
let skipReason: SkipReason | undefined;

if (!val.version) {
skipStage = 'extract';
skipReason = 'unspecified-version';
}

return {
.transform(
({ with: val }): PackageDependency => ({
datasource: DockerDatasource.id,
depName: 'ghcr.io/zizmorcore/zizmor',
packageName: 'ghcr.io/zizmorcore/zizmor',
...(skipStage && { skipStage }),
...(skipReason && { skipReason }),
currentValue: val.version,
depType: 'uses-with',
};
});
...parseValue(val.version),
}),
);

const SetupPyright = z
.object({
uses: matchAction('jakebailey/pyright-action'),
with: z.object({ version: z.string().optional() }),
})
.transform(({ with: val }): PackageDependency => {
let skipStage: StageName | undefined;
let skipReason: SkipReason | undefined;

if (!val.version || val.version === 'PATH') {
skipStage = 'extract';
skipReason = 'unspecified-version';
}

return {
.transform(
({ with: val }): PackageDependency => ({
datasource: NpmDatasource.id,
depName: 'pyright',
versioning: npmVersioning.id,
packageName: 'pyright',
...(skipStage && { skipStage }),
...(skipReason && { skipReason }),
currentValue: val.version,
depType: 'uses-with',
};
});
...parseValue(val.version, () => val.version === 'PATH'),
}),
);

/**
* schema here should match the whole step,
Expand Down
Loading
Loading