{"id":13625641,"url":"https://github.com/volta-cli/action","last_synced_at":"2025-04-07T21:16:16.670Z","repository":{"id":40732722,"uuid":"215644717","full_name":"volta-cli/action","owner":"volta-cli","description":"GitHub Action to Setup Volta","archived":false,"fork":false,"pushed_at":"2024-09-29T13:57:02.000Z","size":26473,"stargazers_count":91,"open_issues_count":9,"forks_count":24,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-14T14:06:45.489Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"https://volta.sh","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/volta-cli.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-16T21:07:24.000Z","updated_at":"2024-10-10T04:09:27.000Z","dependencies_parsed_at":"2024-01-14T08:10:58.884Z","dependency_job_id":"7ef0c8a9-bea6-4ab6-8643-def5a300d781","html_url":"https://github.com/volta-cli/action","commit_stats":{"total_commits":225,"total_committers":15,"mean_commits":15.0,"dds":0.2222222222222222,"last_synced_commit":"979638c778c5abd4794f0ed83a764baf9ef381aa"},"previous_names":[],"tags_count":38,"template":false,"template_full_name":"actions/typescript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volta-cli%2Faction","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volta-cli%2Faction/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volta-cli%2Faction/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/volta-cli%2Faction/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/volta-cli","download_url":"https://codeload.github.com/volta-cli/action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247730069,"owners_count":20986404,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2024-08-01T21:01:58.723Z","updated_at":"2025-04-07T21:16:16.644Z","avatar_url":"https://github.com/volta-cli.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# GitHub Action to Setup Volta\n\n\u003cp align=\"left\"\u003e\n  \u003ca href=\"https://github.com/volta-cli/action\"\u003e\u003cimg alt=\"GitHub Actions status\" src=\"https://github.com/volta-cli/action/workflows/CI/badge.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nThis action installs [volta](https://volta.sh) by:\n\n- downloading and caching volta (adding it to your $PATH)\n- optionally downloading and caching a version of node - npm by version spec and add to PATH\n\n\u003c!-- action-docs-inputs action=\"action.yml\" --\u003e\n## Inputs\n\n| name | description | required | default |\n| --- | --- | --- | --- |\n| `volta-version` | \u003cp\u003eVersion of \u003ccode\u003evolta\u003c/code\u003e to fetch and setup. Examples: 0.6.0, 10.15.1, \u0026gt;=10.15.0\u003c/p\u003e | `false` | `\"\"` |\n| `node-version` | \u003cp\u003eVersion Spec of the node version to use.  Examples: 10.6.x, 10.15.1, \u0026gt;=10.15.0\u003c/p\u003e | `false` | `\"\"` |\n| `npm-version` | \u003cp\u003eVersion Spec of the npm version to use.  Examples: 7.5.x, 7.5.3, \u0026gt;=7.5.3\u003c/p\u003e | `false` | `\"\"` |\n| `yarn-version` | \u003cp\u003eVersion Spec of the yarn version to use.  Examples: 1.6.x, 10.15.1, \u0026gt;=10.15.0\u003c/p\u003e | `false` | `\"\"` |\n| `package-json-path` | \u003cp\u003eThe path to the package.json to update when using an explicit \u003ccode\u003enode-version\u003c/code\u003e | \u003ccode\u003eyarn-version\u003c/code\u003e | \u003ccode\u003enpm-version\u003c/code\u003e override. By default, we will use \u003ccode\u003epackage.json\u003c/code\u003e in the checkout root.\u003c/p\u003e | `false` | `\"\"` |\n| `variant` | \u003cp\u003eSpecific variant to install. Example: providing the variant \"linux-openssl-rhel\", which will target installing the volta-${version}-linux-openssl-rhel.tar.gz tarball\u003c/p\u003e | `false` | `\"\"` |\n| `registry-url` | \u003cp\u003eOptional registry to set up for auth. Will set the registry in a project level .npmrc file, and set up auth to read in from env.NODE\u003cem\u003eAUTH\u003c/em\u003eTOKEN\u003c/p\u003e | `false` | `\"\"` |\n| `scope` | \u003cp\u003eOptional scope for authenticating against scoped registries. Will fall back to the repository owner when using the GitHub Packages registry (https://npm.pkg.github.com/).\u003c/p\u003e | `false` | `\"\"` |\n| `token` | \u003cp\u003eUsed to avoid low rate limiting for cached tool downloads.  Since there's a default, this is typically not supplied by the user.\u003c/p\u003e | `false` | `${{ github.token }}` |\n| `always-auth` | \u003cp\u003eSet always-auth in npmrc\u003c/p\u003e | `false` | `false` |\n\u003c!-- action-docs-inputs action=\"action.yml\" --\u003e\n\n## Usage\n\nSee [action.yml](action.yml)\n\nBasic (when the project's `package.json` has a `volta` property with `node` and/or `yarn` versions pinned):\n\n```yaml\nsteps:\n- uses: actions/checkout@v4\n- uses: volta-cli/action@v4\n- run: npm install\n- run: npm test\n```\n\nManually specifying node and/or yarn versions (e.g. to test a project without `volta` in `package.json`):\n\n```yaml\nsteps:\n- uses: actions/checkout@v4\n- uses: volta-cli/action@v4\n  with:\n    node-version: 18.x\n    yarn-version: 1.19.1\n\n- run: yarn install\n- run: yarn test\n```\n\nSetting up a matrix of node versions:\n\n```yaml\nstrategy:\n  matrix:\n    node-version: ['^14.10', '16', '18']\n\nsteps:\n- uses: actions/checkout@v4\n- uses: volta-cli/action@v4\n  with:\n    node-version: ${{ matrix.node-version }}\n\n- run: npm install\n- run: npm test\n```\n\nYou can also specify the version of npm:\n\n```yaml\nstrategy:\n  matrix:\n    node-version: ['^8.12', '10', '12']\n\nsteps:\n- uses: actions/checkout@v4\n- uses: volta-cli/action@v4\n  with:\n    node-version: ${{ matrix.node-version }}\n    npm-version: '7'\n\n- run: npm install\n- run: npm test\n```\n\nIn some cases, you may know the particular variant of the installer that you want to use for Volta. You can specify the `variant` input to the action to use a specific installer:\n\n```yaml\nsteps:\n- uses: actions/checkout@v4\n- uses: volta-cli/action@v4\n  with:\n    variant: 'linux-openssl-rhel'\n\n- run: yarn install\n- run: yarn test\n```\n\nThe `variant` fragment corresponds to a portion of the installer filename, and can be found in the [Volta Releases](https://github.com/volta-cli/volta/releases) page.\n\n## License\n\nThe scripts and documentation in this project are released under the [MIT License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvolta-cli%2Faction","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvolta-cli%2Faction","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvolta-cli%2Faction/lists"}