mirror of
https://github.com/astral-sh/ruff-action.git
synced 2026-09-16 10:21:30 +00:00
Add option to skip Astral mirror downloads (#387)
## Summary - add `download-from-astral-mirror` input defaulting to `true` - skip mirror URL rewriting and download directly from GitHub Releases when disabled - document the input and add unit coverage Fixes #384 Refs: pi-session 019f31bc-bd1c-7276-9b4e-9734fa0aa367 ## Testing - npm run build - npm run check - npm run test:unit
This commit is contained in:
@@ -32,6 +32,7 @@ anything `ruff` can (ex, fix).
|
||||
| `version` | The version of Ruff to install. See [Install specific versions](#install-specific-versions) | discovered from `pyproject.toml`, else `latest` |
|
||||
| `version-file` | The file to read the version from. See [Install a version from a specified version file](#install-a-version-from-a-specified-version-file) | None |
|
||||
| `manifest-file` | URL to a custom Ruff manifest in the `astral-sh/versions` format. | None |
|
||||
| `download-from-astral-mirror` | Download Ruff from the Astral mirror instead of directly from GitHub Releases. | `true` |
|
||||
| `args` | The arguments to pass to the `ruff` command. See [Configuring Ruff] | `check` |
|
||||
| `src` | Source path(s) to run `ruff` on. Supports glob patterns. | [github.workspace] |
|
||||
| `checksum` | The sha256 checksum of the downloaded artifact. | None |
|
||||
@@ -224,10 +225,12 @@ are automatically verified by this action. The sha256 hashes can be found on the
|
||||
|
||||
### GitHub authentication token
|
||||
|
||||
By default, this action resolves available uv versions from
|
||||
[`astral-sh/versions`](https://github.com/astral-sh/versions) and downloads release artifacts from `https://releases.astral.sh`. If this fails this action falls back to downloading from the GitHub releases page of the ruff repository.
|
||||
By default, this action resolves available Ruff versions from
|
||||
[`astral-sh/versions`](https://github.com/astral-sh/versions) and downloads release artifacts from `https://releases.astral.sh`. If this fails this action falls back to downloading from the GitHub releases page of the Ruff repository.
|
||||
|
||||
You can provide a token via `github-token` to authenticate those downloads. By default, the
|
||||
Set `download-from-astral-mirror` to `false` to skip the Astral mirror and download directly from GitHub Releases.
|
||||
|
||||
You can provide a token via `github-token` to authenticate GitHub Releases downloads. By default, the
|
||||
`GITHUB_TOKEN` secret is used, which is automatically provided by GitHub Actions.
|
||||
|
||||
If the default
|
||||
|
||||
@@ -357,6 +357,32 @@ describe("download-version", () => {
|
||||
expect(mockDownloadTool).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("skips the Astral mirror when downloadFromAstralMirror is false", async () => {
|
||||
mockGetArtifact.mockResolvedValue({
|
||||
archiveFormat: "tar.gz",
|
||||
checksum: "abc123",
|
||||
downloadUrl:
|
||||
"https://github.com/astral-sh/ruff/releases/download/0.15.8/ruff-x86_64-unknown-linux-gnu.tar.gz",
|
||||
});
|
||||
|
||||
await downloadVersion(
|
||||
"unknown-linux-gnu",
|
||||
"x86_64",
|
||||
"0.15.8",
|
||||
undefined,
|
||||
"token",
|
||||
undefined,
|
||||
false,
|
||||
);
|
||||
|
||||
expect(mockDownloadTool).toHaveBeenCalledWith(
|
||||
"https://github.com/astral-sh/ruff/releases/download/0.15.8/ruff-x86_64-unknown-linux-gnu.tar.gz",
|
||||
undefined,
|
||||
"token",
|
||||
);
|
||||
expect(mockDownloadTool).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("uses manifest-file checksum metadata when checksum input is unset", async () => {
|
||||
mockGetArtifact.mockResolvedValue({
|
||||
archiveFormat: "tar.gz",
|
||||
|
||||
@@ -23,6 +23,10 @@ inputs:
|
||||
manifest-file:
|
||||
description: "URL to a custom manifest file in the astral-sh/versions format."
|
||||
required: false
|
||||
download-from-astral-mirror:
|
||||
description: "Download Ruff from the Astral mirror instead of directly from GitHub Releases."
|
||||
required: false
|
||||
default: "true"
|
||||
github-token:
|
||||
description:
|
||||
"Used for authenticated downloads of Ruff release artifacts from GitHub."
|
||||
|
||||
BIN
Binary file not shown.
@@ -35,6 +35,7 @@ export async function downloadVersion(
|
||||
checksum: string | undefined,
|
||||
githubToken: string,
|
||||
manifestUrl?: string,
|
||||
downloadFromAstralMirror = true,
|
||||
): Promise<{ version: string; cachedToolDir: string }> {
|
||||
const artifact = await getArtifact(version, arch, platform, manifestUrl);
|
||||
|
||||
@@ -57,6 +58,7 @@ export async function downloadVersion(
|
||||
arch,
|
||||
version,
|
||||
getDownloadToken(artifact.downloadUrl, githubToken),
|
||||
downloadFromAstralMirror,
|
||||
);
|
||||
await validateChecksum(
|
||||
resolvedChecksum,
|
||||
@@ -83,6 +85,10 @@ export async function downloadVersion(
|
||||
return { cachedToolDir, version };
|
||||
}
|
||||
|
||||
/**
|
||||
* Rewrite a GitHub Releases URL to the Astral mirror.
|
||||
* Returns `undefined` if the URL does not match the expected GitHub prefix.
|
||||
*/
|
||||
export function rewriteToMirror(url: string): string | undefined {
|
||||
if (!url.startsWith(GITHUB_RELEASES_PREFIX)) {
|
||||
return undefined;
|
||||
@@ -97,8 +103,11 @@ async function downloadArtifact(
|
||||
arch: Architecture,
|
||||
version: string,
|
||||
githubToken: string | undefined,
|
||||
downloadFromAstralMirror: boolean,
|
||||
): Promise<string> {
|
||||
const mirrorUrl = rewriteToMirror(downloadUrl);
|
||||
const mirrorUrl = downloadFromAstralMirror
|
||||
? rewriteToMirror(downloadUrl)
|
||||
: undefined;
|
||||
const resolvedDownloadUrl = mirrorUrl ?? downloadUrl;
|
||||
|
||||
try {
|
||||
|
||||
+10
-1
@@ -9,6 +9,7 @@ import {
|
||||
import {
|
||||
args,
|
||||
checkSum,
|
||||
downloadFromAstralMirror,
|
||||
githubToken,
|
||||
manifestFile,
|
||||
src,
|
||||
@@ -39,7 +40,13 @@ async function run(): Promise<void> {
|
||||
if (arch === undefined) {
|
||||
throw new Error(`Unsupported architecture: ${process.arch}`);
|
||||
}
|
||||
const setupResult = await setupRuff(platform, arch, checkSum, githubToken);
|
||||
const setupResult = await setupRuff(
|
||||
platform,
|
||||
arch,
|
||||
checkSum,
|
||||
githubToken,
|
||||
downloadFromAstralMirror,
|
||||
);
|
||||
|
||||
addRuffToPath(setupResult.ruffDir);
|
||||
setOutputFormat();
|
||||
@@ -60,6 +67,7 @@ async function setupRuff(
|
||||
arch: Architecture,
|
||||
checkSum: string | undefined,
|
||||
githubToken: string,
|
||||
downloadFromAstralMirror: boolean,
|
||||
): Promise<{ ruffDir: string; version: string }> {
|
||||
const resolvedVersion = await determineVersion();
|
||||
const manifestUrl = manifestFile || undefined;
|
||||
@@ -84,6 +92,7 @@ async function setupRuff(
|
||||
checkSum,
|
||||
githubToken,
|
||||
manifestUrl,
|
||||
downloadFromAstralMirror,
|
||||
);
|
||||
|
||||
return {
|
||||
|
||||
@@ -7,3 +7,14 @@ export const args = core.getInput("args");
|
||||
export const src = core.getInput("src");
|
||||
export const versionFile = core.getInput("version-file");
|
||||
export const manifestFile = core.getInput("manifest-file");
|
||||
export const downloadFromAstralMirror = getBooleanInput(
|
||||
"download-from-astral-mirror",
|
||||
true,
|
||||
);
|
||||
|
||||
function getBooleanInput(name: string, defaultValue: boolean): boolean {
|
||||
if (core.getInput(name) === "") {
|
||||
return defaultValue;
|
||||
}
|
||||
return core.getBooleanInput(name);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user