├── .eslintrc.json ├── action.yaml ├── LICENSE-MIT ├── setup-crate ├── package.json ├── tsconfig.json └── src │ └── index.ts ├── package.json ├── .github └── workflows │ └── build.yaml ├── src └── index.ts ├── .gitignore ├── README.md ├── tsconfig.json └── LICENSE-APACHE /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "env": { 3 | "browser": true, 4 | "es6": true 5 | }, 6 | "extends": [ 7 | "eslint:recommended", 8 | "plugin:@typescript-eslint/eslint-recommended" 9 | ], 10 | "globals": { 11 | "Atomics": "readonly", 12 | "SharedArrayBuffer": "readonly" 13 | }, 14 | "parser": "@typescript-eslint/parser", 15 | "parserOptions": { 16 | "ecmaVersion": 2018, 17 | "sourceType": "module" 18 | }, 19 | "plugins": [ 20 | "@typescript-eslint" 21 | ], 22 | "rules": { 23 | } 24 | } -------------------------------------------------------------------------------- /action.yaml: -------------------------------------------------------------------------------- 1 | name: 'Setup crate' 2 | author: 'Ross MacArthur' 3 | description: 'Install any Rust crate' 4 | branding: 5 | icon: 'settings' 6 | color: 'red' 7 | inputs: 8 | repo: 9 | required: false 10 | description: 'The GitHub repository and version specifier containing the crate' 11 | owner: 12 | required: false 13 | description: 'The GitHub user or organization' 14 | name: 15 | required: false 16 | description: 'The GitHub repository name' 17 | version: 18 | required: false 19 | description: 'A valid semver specifier of the crate version to install' 20 | github-token: 21 | required: false 22 | description: 'The GitHub token used for making API requests' 23 | default: ${{ github.token }} 24 | runs: 25 | using: 'node20' 26 | main: 'dist/index.js' 27 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | Permission is hereby granted, free of charge, to any person obtaining a copy 2 | of this software and associated documentation files (the "Software"), to deal 3 | in the Software without restriction, including without limitation the rights 4 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 5 | copies of the Software, and to permit persons to whom the Software is 6 | furnished to do so, subject to the following conditions: 7 | 8 | The above copyright notice and this permission notice shall be included in all 9 | copies or substantial portions of the Software. 10 | 11 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 12 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 13 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 14 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 15 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 16 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 17 | SOFTWARE. 18 | -------------------------------------------------------------------------------- /setup-crate/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@extractions/setup-crate", 3 | "version": "0.5.0", 4 | "description": "Install a Rust crate.", 5 | "author": "Ross MacArthur ", 6 | "license": "MIT OR Apache-2.0", 7 | "homepage": "https://github.com/extractions/setup-crate#readme", 8 | "repository": { 9 | "type": "git", 10 | "url": "git+https://github.com/extractions/setup-crate.git" 11 | }, 12 | "bugs": { 13 | "url": "https://github.com/extractions/setup-crate/issues" 14 | }, 15 | "scripts": { 16 | "build": "tsc", 17 | "fmt": "prettier --write src/**/*.ts", 18 | "lint": "eslint src/**/*.ts" 19 | }, 20 | "files": [ 21 | "lib/**/*" 22 | ], 23 | "publishConfig": { 24 | "access": "public" 25 | }, 26 | "main": "lib/index.js", 27 | "types": "lib/index.d.ts", 28 | "dependencies": { 29 | "@actions/core": "^1.9.1", 30 | "@actions/tool-cache": "^2.0.1", 31 | "@octokit/rest": "^21.0.0", 32 | "semver": "^7.3.7" 33 | }, 34 | "devDependencies": { 35 | "@types/node": "^20.14.10", 36 | "@types/semver": "^7.5.8", 37 | "@typescript-eslint/eslint-plugin": "^7.16.0", 38 | "@typescript-eslint/parser": "^7.16.0", 39 | "eslint": "^8.56.0", 40 | "prettier": "^3.3.2", 41 | "typescript": "^5.5.3" 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "setup-crate-action", 3 | "version": "1.4.0", 4 | "description": "Install any Rust crate", 5 | "main": "dist/index.js", 6 | "private": true, 7 | "scripts": { 8 | "fmt": "prettier --write **/*.ts", 9 | "lint": "eslint **/*.ts", 10 | "build": "npm run -w setup-crate build && rm -rf dist/ && ncc build src/index.ts --minify", 11 | "run": "npm run build && RUNNER_TOOL_CACHE=./runner/cache RUNNER_TEMP=./runner/temp node dist/index.js" 12 | }, 13 | "repository": { 14 | "type": "git", 15 | "url": "git+https://github.com/extractions/setup-crate.git" 16 | }, 17 | "author": "Ross MacArthur ", 18 | "license": "MIT OR Apache-2.0", 19 | "bugs": { 20 | "url": "https://github.com/extractions/setup-crate/issues" 21 | }, 22 | "homepage": "https://github.com/extractions/setup-crate#readme", 23 | "dependencies": { 24 | "@actions/core": "^1.10.1", 25 | "@extractions/setup-crate": "^0.5.0" 26 | }, 27 | "devDependencies": { 28 | "@types/node": "^20.14.10", 29 | "@types/semver": "^7.5.8", 30 | "@typescript-eslint/eslint-plugin": "^7.16.0", 31 | "@typescript-eslint/parser": "^7.16.0", 32 | "@vercel/ncc": "^0.38.1", 33 | "eslint": "^8.56.0", 34 | "prettier": "^3.3.2", 35 | "typescript": "^5.5.3" 36 | }, 37 | "workspaces": [ 38 | "./setup-crate" 39 | ] 40 | } 41 | -------------------------------------------------------------------------------- /.github/workflows/build.yaml: -------------------------------------------------------------------------------- 1 | name: build 2 | 3 | on: 4 | push: 5 | schedule: 6 | - cron: 0 12 1 * * 7 | 8 | jobs: 9 | build: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v4 13 | - uses: actions/setup-node@v4 14 | with: 15 | node-version: '20' 16 | - run: npm ci 17 | - run: npm run lint 18 | - run: npm run build 19 | 20 | test: 21 | strategy: 22 | matrix: 23 | os: [ubuntu-latest, macos-12, windows-latest] 24 | repo: 25 | - casey/just 26 | - Michael-F-Bryan/mdbook-linkcheck 27 | - rossmacarthur/sheldon 28 | - rust-embedded/cross 29 | - rust-lang/mdBook 30 | - rustwasm/wasm-bindgen 31 | - sharkdp/hyperfine 32 | include: 33 | # rossmacarthur/powerpack only ships a macos binary 34 | - os: macos-latest 35 | repo: rossmacarthur/powerpack 36 | exclude: 37 | # rossmacarthur/sheldon does not ship a windows binary 38 | - os: windows-latest 39 | repo: rossmacarthur/sheldon 40 | 41 | runs-on: ${{ matrix.os }} 42 | name: test (${{matrix.os}}, ${{ matrix.repo }}) 43 | steps: 44 | - uses: actions/checkout@v4 45 | - name: Setup ${{ matrix.repo }} 46 | uses: ./ 47 | with: 48 | repo: ${{ matrix.repo }} 49 | env: 50 | ACTIONS_STEP_DEBUG: true 51 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 52 | - name: Test 53 | run: which $(printf ${{ matrix.repo }} | awk -F '/' '{print $2}' | tr '[:upper:]' '[:lower:]') 54 | shell: bash 55 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | import * as core from '@actions/core'; 2 | import * as setup from '@extractions/setup-crate'; 3 | 4 | async function main() { 5 | try { 6 | 7 | const repoSpec = core.getInput("repo"); 8 | let owner = core.getInput("owner"); 9 | let name = core.getInput("name"); 10 | const githubToken = core.getInput("github-token"); 11 | let versionSpec = core.getInput("version"); 12 | 13 | // Repo and owner+name are mutually exclusive 14 | if (repoSpec) { 15 | if (owner || name) { 16 | core.setFailed("When 'repo' is supplied, 'owner' and 'name' must not be provided"); 17 | return; 18 | } 19 | } else { 20 | if (!owner || !name) { 21 | core.setFailed("Both 'owner' and 'name' must be supplied when 'repo' is not provided"); 22 | return; 23 | } 24 | } 25 | 26 | // Parse the repo spec if it was provided 27 | if (repoSpec) { 28 | const [repo, version] = repoSpec.split("@", 2); 29 | if (version && versionSpec) { 30 | core.setFailed("Both 'version' and 'repo' have a version specified, only one is allowed"); 31 | return 32 | } 33 | versionSpec = version || versionSpec; 34 | [owner, name] = repo.split("/", 2); 35 | } 36 | 37 | const tool = await setup.checkOrInstallTool( 38 | { owner, name, versionSpec }, 39 | { auth: githubToken }, 40 | ); 41 | core.addPath(tool.dir); 42 | core.info(`Successfully setup ${tool.name} v${tool.version}`); 43 | } catch (err) { 44 | if (err instanceof Error) { 45 | core.setFailed(err.message); 46 | } 47 | } 48 | } 49 | 50 | main(); 51 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | lib 2 | /runner 3 | 4 | # Created by https://www.toptal.com/developers/gitignore/api/node 5 | # Edit at https://www.toptal.com/developers/gitignore?templates=node 6 | 7 | ### Node ### 8 | # Logs 9 | logs 10 | *.log 11 | npm-debug.log* 12 | yarn-debug.log* 13 | yarn-error.log* 14 | lerna-debug.log* 15 | 16 | # Diagnostic reports (https://nodejs.org/api/report.html) 17 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 18 | 19 | # Runtime data 20 | pids 21 | *.pid 22 | *.seed 23 | *.pid.lock 24 | 25 | # Directory for instrumented libs generated by jscoverage/JSCover 26 | lib-cov 27 | 28 | # Coverage directory used by tools like istanbul 29 | coverage 30 | *.lcov 31 | 32 | # nyc test coverage 33 | .nyc_output 34 | 35 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 36 | .grunt 37 | 38 | # Bower dependency directory (https://bower.io/) 39 | bower_components 40 | 41 | # node-waf configuration 42 | .lock-wscript 43 | 44 | # Compiled binary addons (https://nodejs.org/api/addons.html) 45 | build/Release 46 | 47 | # Dependency directories 48 | node_modules/ 49 | jspm_packages/ 50 | 51 | # TypeScript v1 declaration files 52 | typings/ 53 | 54 | # TypeScript cache 55 | *.tsbuildinfo 56 | 57 | # Optional npm cache directory 58 | .npm 59 | 60 | # Optional eslint cache 61 | .eslintcache 62 | 63 | # Optional stylelint cache 64 | .stylelintcache 65 | 66 | # Microbundle cache 67 | .rpt2_cache/ 68 | .rts2_cache_cjs/ 69 | .rts2_cache_es/ 70 | .rts2_cache_umd/ 71 | 72 | # Optional REPL history 73 | .node_repl_history 74 | 75 | # Output of 'npm pack' 76 | *.tgz 77 | 78 | # Yarn Integrity file 79 | .yarn-integrity 80 | 81 | # dotenv environment variables file 82 | .env 83 | .env.test 84 | .env*.local 85 | 86 | # parcel-bundler cache (https://parceljs.org/) 87 | .cache 88 | .parcel-cache 89 | 90 | # Next.js build output 91 | .next 92 | 93 | # Nuxt.js build / generate output 94 | .nuxt 95 | dist 96 | 97 | # Gatsby files 98 | .cache/ 99 | # Comment in the public line in if your project uses Gatsby and not Next.js 100 | # https://nextjs.org/blog/next-9-1#public-directory-support 101 | # public 102 | 103 | # vuepress build output 104 | .vuepress/dist 105 | 106 | # Serverless directories 107 | .serverless/ 108 | 109 | # FuseBox cache 110 | .fusebox/ 111 | 112 | # DynamoDB Local files 113 | .dynamodb/ 114 | 115 | # TernJS port file 116 | .tern-port 117 | 118 | # Stores VSCode versions used for testing VSCode extensions 119 | .vscode-test 120 | 121 | # End of https://www.toptal.com/developers/gitignore/api/node 122 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # setup-crate 2 | 3 | [![Build Status](https://img.shields.io/github/actions/workflow/status/extractions/setup-crate/build.yaml?branch=trunk)](https://github.com/extractions/setup-crate/actions/workflows/build.yaml) 4 | 5 | This GitHub Action will install a release of a Rust crate for you. 6 | 7 | ## Introduction 8 | 9 | This action will work for any project that satisfies the following conditions: 10 | - The project is a public GitHub project. 11 | - The project uses GitHub releases with semver tag names. 12 | - The project attaches assets to the GitHub release that contain a Rust target. 13 | The following targets are looked for: 14 | 15 | | Arch | Node Platform | Targets | 16 | | ------- | ------------- | ----------------------------------------------------------- | 17 | | `x64` | `linux` | `x86_64-unknown-linux-musl` or `x86_64-unknown-linux-gnu` | 18 | | `x64` | `darwin` | `x86_64-apple-darwin` | 19 | | `x64` | `win32` | `x86_64-pc-windows-msvc` | 20 | | `arm64` | `linux` | `aarch64-unknown-linux-musl` or `aarch64-unknown-linux-gnu` | 21 | | `arm64` | `darwin` | `aarch64-apple-darwin` | 22 | 23 | - The asset is a `.tar.gz` or `.zip` archive that contains a binary with the 24 | project name. 25 | 26 | ## Usage 27 | 28 | ### Examples 29 | 30 | In most cases all you will need is to specify `repo` and the `owner/name` of the 31 | project in your workflow. For example the following installs the latest version 32 | of [mdBook](https://github.com/rust-lang/mdBook). 33 | 34 | ```yaml 35 | - uses: extractions/setup-crate@v1 36 | with: 37 | repo: rust-lang/mdBook 38 | ``` 39 | 40 | If you want a specific version you can specify this by suffixing version to the 41 | input. For example the following installs the latest `0.10.x` version of 42 | [just](https://github.com/casey/just). 43 | 44 | ```yaml 45 | - uses: extractions/setup-crate@v1 46 | with: 47 | repo: casey/just@0.10 48 | ``` 49 | 50 | ### Inputs 51 | 52 | | Name | Required | Description | Type | Default | 53 | | -------------- | -------- | ------------------------------------------------------------------- | ------ | --------------------------- | 54 | | `repo` | no | The GitHub repository name and valid NPM-style semver specification | string | | 55 | | `github-token` | no | The GitHub token for making API requests | string | ${{ secrets.GITHUB_TOKEN }} | 56 | 57 | The semver specification is passed directly to NPM's [semver 58 | package](https://www.npmjs.com/package/semver). This GitHub Action will install 59 | the latest matching release. Examples include 60 | 61 | - `version: '*'` latest version (default). 62 | - `version: '0.1'` equivalent to `>=0.1.0 <0.2.0`. 63 | - `version: '0.1.x'` equivalent to `>=0.1.0 <0.2.0`. 64 | - `version: '0.1.0'` equivalent to `=0.1.0`. 65 | - `version: '^0.1.0'` equivalent to `>=0.1.0 <0.2.0`. 66 | 67 | ### Deprecated inputs 68 | 69 | The following inputs are still supported for now but will be removed in a future 70 | release. 71 | 72 | | Name | Required | Description | Type | Default | 73 | | --------- | -------- | -------------------------------------- | ------ | ------- | 74 | | `owner` | no | The GitHub user or organization name | string | | 75 | | `name` | no | The GitHub repository name | string | | 76 | | `version` | no | A valid NPM-style semver specification | string | * | 77 | 78 | ## License 79 | 80 | Licensed under either of 81 | 82 | - Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or 83 | http://www.apache.org/licenses/LICENSE-2.0) 84 | - MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) 85 | 86 | at your option. 87 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | /* Basic Options */ 4 | // "incremental": true, /* Enable incremental compilation */ 5 | "target": "es6", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */ 6 | "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */ 7 | // "lib": [], /* Specify library files to be included in the compilation. */ 8 | // "allowJs": true, /* Allow javascript files to be compiled. */ 9 | // "checkJs": true, /* Report errors in .js files. */ 10 | // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ 11 | // "declaration": true, /* Generates corresponding '.d.ts' file. */ 12 | // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ 13 | "sourceMap": true, /* Generates corresponding '.map' file. */ 14 | // "outFile": "./", /* Concatenate and emit output to single file. */ 15 | "outDir": "./lib", /* Redirect output structure to the directory. */ 16 | "rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ 17 | // "composite": true, /* Enable project compilation */ 18 | // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ 19 | // "removeComments": true, /* Do not emit comments to output. */ 20 | // "noEmit": true, /* Do not emit outputs. */ 21 | // "importHelpers": true, /* Import emit helpers from 'tslib'. */ 22 | // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ 23 | // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ 24 | 25 | /* Strict Type-Checking Options */ 26 | "strict": true, /* Enable all strict type-checking options. */ 27 | // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ 28 | // "strictNullChecks": true, /* Enable strict null checks. */ 29 | // "strictFunctionTypes": true, /* Enable strict checking of function types. */ 30 | // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ 31 | // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ 32 | // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ 33 | // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ 34 | 35 | /* Additional Checks */ 36 | // "noUnusedLocals": true, /* Report errors on unused locals. */ 37 | // "noUnusedParameters": true, /* Report errors on unused parameters. */ 38 | // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ 39 | // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ 40 | 41 | /* Module Resolution Options */ 42 | "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ 43 | // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ 44 | // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ 45 | // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ 46 | // "typeRoots": [], /* List of folders to include type definitions from. */ 47 | // "types": [], /* Type declaration files to be included in compilation. */ 48 | // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ 49 | "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ 50 | // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ 51 | // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ 52 | 53 | /* Source Map Options */ 54 | // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ 55 | // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ 56 | // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ 57 | // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ 58 | 59 | /* Experimental Options */ 60 | // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ 61 | // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ 62 | 63 | /* Advanced Options */ 64 | "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */ 65 | }, 66 | "include": ["src"], 67 | "exclude": ["node_modules", "**/__tests__/*"] 68 | } 69 | -------------------------------------------------------------------------------- /setup-crate/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | /* Visit https://aka.ms/tsconfig.json to read more about this file */ 4 | 5 | /* Basic Options */ 6 | // "incremental": true, /* Enable incremental compilation */ 7 | "target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */ 8 | "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */ 9 | // "lib": [], /* Specify library files to be included in the compilation. */ 10 | // "allowJs": true, /* Allow javascript files to be compiled. */ 11 | // "checkJs": true, /* Report errors in .js files. */ 12 | // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ 13 | "declaration": true, /* Generates corresponding '.d.ts' file. */ 14 | // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ 15 | // "sourceMap": true, /* Generates corresponding '.map' file. */ 16 | // "outFile": "./", /* Concatenate and emit output to single file. */ 17 | "outDir": "./lib", /* Redirect output structure to the directory. */ 18 | "rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ 19 | // "composite": true, /* Enable project compilation */ 20 | // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ 21 | // "removeComments": true, /* Do not emit comments to output. */ 22 | // "noEmit": true, /* Do not emit outputs. */ 23 | // "importHelpers": true, /* Import emit helpers from 'tslib'. */ 24 | // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ 25 | // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ 26 | 27 | /* Strict Type-Checking Options */ 28 | "strict": true, /* Enable all strict type-checking options. */ 29 | // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ 30 | // "strictNullChecks": true, /* Enable strict null checks. */ 31 | // "strictFunctionTypes": true, /* Enable strict checking of function types. */ 32 | // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ 33 | // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ 34 | // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ 35 | // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ 36 | 37 | /* Additional Checks */ 38 | // "noUnusedLocals": true, /* Report errors on unused locals. */ 39 | // "noUnusedParameters": true, /* Report errors on unused parameters. */ 40 | // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ 41 | // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ 42 | // "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */ 43 | 44 | /* Module Resolution Options */ 45 | // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ 46 | // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ 47 | // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ 48 | // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ 49 | // "typeRoots": [], /* List of folders to include type definitions from. */ 50 | // "types": [], /* Type declaration files to be included in compilation. */ 51 | // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ 52 | "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ 53 | // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ 54 | // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ 55 | 56 | /* Source Map Options */ 57 | // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ 58 | // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ 59 | // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ 60 | // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ 61 | 62 | /* Experimental Options */ 63 | // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ 64 | // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ 65 | 66 | /* Advanced Options */ 67 | "skipLibCheck": true, /* Skip type checking of declaration files. */ 68 | "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */ 69 | }, 70 | "include": ["src"], 71 | "exclude": ["node_modules", "**/__tests__/*"] 72 | } 73 | -------------------------------------------------------------------------------- /setup-crate/src/index.ts: -------------------------------------------------------------------------------- 1 | import { 2 | constants as fs_constants, 3 | promises as fs, 4 | } from 'fs'; 5 | import * as path from 'path'; 6 | import * as semver from 'semver'; 7 | 8 | import * as core from '@actions/core'; 9 | import * as tc from '@actions/tool-cache'; 10 | import { Octokit } from '@octokit/rest'; 11 | 12 | /** 13 | * @returns {string[]} possible Rust target specifiers for the current platform. 14 | */ 15 | function getTargets(): string[] { 16 | const { arch, platform } = process; 17 | if (arch == "x64") { 18 | if (platform == "linux") { 19 | return ["x86_64-unknown-linux-musl", "x86_64-unknown-linux-gnu"]; 20 | } else if (platform == "darwin") { 21 | return ["x86_64-apple-darwin"]; 22 | } else if (platform == "win32") { 23 | return ["x86_64-pc-windows-msvc"]; 24 | } 25 | } 26 | if (arch == "arm64") { 27 | if (platform == "linux") { 28 | return ["aarch64-unknown-linux-musl", "aarch64-unknown-linux-gnu"]; 29 | } else if (platform == "darwin") { 30 | return ["aarch64-apple-darwin"]; 31 | } 32 | } 33 | throw new Error( 34 | `failed to determine any valid targets; arch = ${arch}, platform = ${platform}`, 35 | ); 36 | } 37 | 38 | /** 39 | * Options that this package supports. 40 | */ 41 | export interface Options { 42 | /** Passed to Octokit auth, typically the GITHUB_TOKEN */ 43 | auth: any; 44 | } 45 | 46 | /** 47 | * Represents a tool to install from GitHub. 48 | */ 49 | export interface Tool { 50 | /** The GitHub owner (username or organization). */ 51 | owner: string; 52 | /** The GitHub repo name. */ 53 | name: string; 54 | /** A valid semantic version specifier for the tool. */ 55 | versionSpec?: string; 56 | /** The name of the tool binary (defaults to the repo name) */ 57 | bin?: string; 58 | } 59 | 60 | /** 61 | * Represents an installed tool. 62 | */ 63 | export interface InstalledTool { 64 | /** The GitHub owner (username or organization). */ 65 | owner: string; 66 | /** The GitHub repo name. */ 67 | name: string; 68 | /** The version of the tool. */ 69 | version: string; 70 | /** The directory containing the tool binary. */ 71 | dir: string; 72 | /** The name of the tool binary (defaults to the repo name) */ 73 | bin?: string; 74 | } 75 | 76 | /** 77 | * Represents a single release for a {@link Tool}. 78 | */ 79 | interface Release { 80 | /** The exact release tag. */ 81 | version: string; 82 | /** The asset download URL. */ 83 | downloadUrl: string; 84 | } 85 | 86 | /** 87 | * Fetch the latest matching release for the given tool. 88 | * 89 | * @param tool the tool to fetch a release for. 90 | * 91 | * @returns {Promise} a single GitHub release. 92 | */ 93 | async function getRelease(tool: Tool, options?: Options): Promise { 94 | const targets = getTargets(); 95 | const { owner, name, versionSpec } = tool; 96 | const octokit = new Octokit(options); 97 | return octokit 98 | .paginate( 99 | "GET /repos/{owner}/{repo}/releases", 100 | { owner, repo: name }, 101 | (response, done) => { 102 | const releases = response.data 103 | .map((rel): Release | undefined => { 104 | const asset = rel.assets.find((ass) => 105 | targets.some((target) => ass.name.includes(target)), 106 | ); 107 | if (asset) { 108 | return { 109 | version: rel.tag_name.replace(/^v/, ""), 110 | downloadUrl: asset.browser_download_url, 111 | }; 112 | } 113 | }) 114 | .filter((rel) => Boolean(rel)) 115 | .filter((rel) => 116 | rel && versionSpec 117 | ? semver.satisfies(rel.version, versionSpec) 118 | : true, 119 | ); 120 | if (releases.length > 0) { 121 | done(); 122 | } 123 | return releases; 124 | }, 125 | ) 126 | .then((releases) => { 127 | const release = releases.find((release) => release != null); 128 | if (release === undefined) { 129 | throw new Error( 130 | `no release for ${name} matching version specifier ${versionSpec}`, 131 | ); 132 | } 133 | return release; 134 | }); 135 | } 136 | 137 | async function handleBadBinaryPermissions( 138 | tool: Tool, 139 | dir: string, 140 | ): Promise { 141 | const { name, bin } = tool; 142 | if (process.platform !== "win32") { 143 | const findBin = async () => { 144 | const files = await fs.readdir(dir); 145 | for await (const file of files) { 146 | if (file.toLowerCase() == name.toLowerCase()) { 147 | return file; 148 | } 149 | } 150 | return name; 151 | }; 152 | const binary = path.join(dir, bin ? bin : await findBin()); 153 | try { 154 | await fs.access(binary, fs_constants.X_OK); 155 | } catch { 156 | await fs.chmod(binary, "755"); 157 | core.debug(`Fixed file permissions (-> 0o755) for ${binary}`); 158 | } 159 | } 160 | } 161 | 162 | /** 163 | * Checks the tool cache for the tool, and if it is missing fetches it from 164 | * GitHub releases. 165 | * 166 | * @param tool the tool to check or install. 167 | * 168 | * @returns the directory containing the tool binary. 169 | */ 170 | export async function checkOrInstallTool( 171 | tool: Tool, 172 | options?: Options, 173 | ): Promise { 174 | const { name, versionSpec } = tool; 175 | 176 | // first check if we have previously downloaded the tool 177 | let dir = tc.find(name, versionSpec || "*"); 178 | 179 | if (!dir) { 180 | // find the latest release by querying GitHub API 181 | const { version, downloadUrl } = await getRelease(tool, options); 182 | 183 | // download, extract, and cache the tool 184 | const artifact = await tc.downloadTool(downloadUrl); 185 | core.debug(`Successfully downloaded ${name} v${version}`); 186 | 187 | let extractDir; 188 | if (downloadUrl.endsWith(".zip")) { 189 | extractDir = await tc.extractZip(artifact); 190 | } else { 191 | extractDir = await tc.extractTar(artifact); 192 | } 193 | core.debug(`Successfully extracted archive for ${name} v${version}`); 194 | 195 | // handle the case where there is a single directory extracted 196 | const files = await fs.readdir(extractDir); 197 | if (files.length == 1) { 198 | const maybeDir = path.join(extractDir, files[0]); 199 | if ((await fs.lstat(maybeDir)).isDirectory()) { 200 | extractDir = maybeDir; 201 | } 202 | } 203 | 204 | dir = await tc.cacheDir(extractDir, name, version); 205 | 206 | // handle bad binary permissions, the binary needs to be executable! 207 | await handleBadBinaryPermissions(tool, dir); 208 | } 209 | 210 | // FIXME: is there a better way to get the version? 211 | const version = path.basename(path.dirname(dir)); 212 | 213 | return { version, dir, ...tool }; 214 | } 215 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------