Add support for custom download URL

astral-sh · Feb 24, 2025 · 56cf771 · 56cf771
1 parent 19e5e84
commit 56cf771
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -26,14 +26,15 @@ fix).
 
 ## Usage
 
-| Input          | Description                                                                                                                                | Default            |
-|----------------|--------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
-| `version`      | The version of Ruff to install. See [Install specific versions](#install-specific-versions)                                                | `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               |
-| `args`         | The arguments to pass to the `ruff` command. See [Configuring Ruff]                                                                        | `check`            |
-| `src`          | The directory or single files to run `ruff` on.                                                                                            | [github.workspace] |
-| `checksum`     | The sha256 checksum of the downloaded executable.                                                                                          | None               |
-| `github-token` | The GitHub token to use for authentication.                                                                                                | `GITHUB_TOKEN`     |
+| Input                 | Description                                                                                                                                | Default                                                                                  |
+| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- |
+| `version`             | The version of Ruff to install. See [Install specific versions](#install-specific-versions)                                                | `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                                                                                     |
+| `args`                | The arguments to pass to the `ruff` command. See [Configuring Ruff]                                                                        | `check`                                                                                  |
+| `src`                 | The directory or single files to run `ruff` on.                                                                                            | [github.workspace]                                                                       |
+| `checksum`            | The sha256 checksum of the downloaded executable.                                                                                          | None                                                                                     |
+| `github-token`        | The GitHub token to use for authentication.                                                                                                | `GITHUB_TOKEN`                                                                           |
+| `custom-download-url` | Custom download URL for ruff.                                                                                                              | https://github.com/${OWNER}/${REPO}/releases/download/${version}/${artifact}${extension} |
 
 ### Basic
 
@@ -167,10 +168,9 @@ are not sufficient, you can provide a custom GitHub token with the necessary per
 ## Outputs
 
 | Output         | Description                             |
-|----------------|-----------------------------------------|
+| -------------- | --------------------------------------- |
 | `ruff-version` | The version of Ruff that was installed. |
 
-
 <div align="center">
   <a target="_blank" href="https://astral.sh" style="background:none">
     <img src="https://raw.githubusercontent.com/astral-sh/uv/main/assets/svg/Astral.svg" alt="Made by Astral">

diff --git a/action.yml b/action.yml
@@ -26,6 +26,10 @@ inputs:
       ruff."
     required: false
     default: ${{ github.token }}
+  custom-download-url:
+    description: "Custom URL to download the ruff version from"
+    required: false
+    default: "https://github.com/${OWNER}/${REPO}/releases/download/${version}/${artifact}${extension}"
 outputs:
   ruff-version:
     description: "The installed ruff version. Useful when using latest."

diff --git a/src/download/download-version.ts b/src/download/download-version.ts
@@ -32,13 +32,14 @@ export async function downloadVersion(
   version: string,
   checkSum: string | undefined,
   githubToken: string,
+  customDownloadUrl?: string,
 ): Promise<{ version: string; cachedToolDir: string }> {
   const artifact = `ruff-${arch}-${platform}`;
   let extension = ".tar.gz";
   if (platform === "pc-windows-msvc") {
     extension = ".zip";
   }
-  const downloadUrl = `https://github.com/${OWNER}/${REPO}/releases/download/${version}/${artifact}${extension}`;
+  const downloadUrl = customDownloadUrl || `https://github.com/${OWNER}/${REPO}/releases/download/${version}/${artifact}${extension}`;
   core.info(`Downloading ruff from "${downloadUrl}" ...`);
 
   const downloadPath = await tc.downloadTool(

diff --git a/src/utils/inputs.ts b/src/utils/inputs.ts
@@ -6,3 +6,4 @@ export const githubToken = core.getInput("github-token");
 export const args = core.getInput("args");
 export const src = core.getInput("src");
 export const versionFile = core.getInput("version-file");
+export const customDownloadUrl = core.getInput("custom-download-url");