{"id":26454073,"url":"https://github.com/sylvaindumas/setup-sonar-scanner","last_synced_at":"2026-05-20T06:02:36.870Z","repository":{"id":280498743,"uuid":"940221302","full_name":"SylvainDumas/setup-sonar-scanner","owner":"SylvainDumas","description":"action setup the Scanner CLI for SonarQube (Server, Cloud)","archived":false,"fork":false,"pushed_at":"2025-03-14T22:12:16.000Z","size":540,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-14T22:29:15.662Z","etag":null,"topics":["github-actions","github-actions-typescript","sonarcloud","sonarqube"],"latest_commit_sha":null,"homepage":"","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/SylvainDumas.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2025-02-27T20:09:04.000Z","updated_at":"2025-03-08T19:02:37.000Z","dependencies_parsed_at":"2025-03-03T19:46:33.670Z","dependency_job_id":null,"html_url":"https://github.com/SylvainDumas/setup-sonar-scanner","commit_stats":null,"previous_names":["sylvaindumas/setup-sonar-scanner"],"tags_count":0,"template":false,"template_full_name":"actions/typescript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SylvainDumas%2Fsetup-sonar-scanner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SylvainDumas%2Fsetup-sonar-scanner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SylvainDumas%2Fsetup-sonar-scanner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SylvainDumas%2Fsetup-sonar-scanner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SylvainDumas","download_url":"https://codeload.github.com/SylvainDumas/setup-sonar-scanner/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244290626,"owners_count":20429396,"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":["github-actions","github-actions-typescript","sonarcloud","sonarqube"],"created_at":"2025-03-18T19:39:05.614Z","updated_at":"2026-05-20T06:02:36.864Z","avatar_url":"https://github.com/SylvainDumas.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Setup SonarQube Scanner Action\n\n[![Conventional Branch](https://img.shields.io/badge/Conventional%20Branch-1.0.0-blue.svg)](https://conventional-branch.github.io)\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-blue.svg)](https://conventionalcommits.org)\n[![SemVer](https://img.shields.io/badge/SemVer-2.0.0-blue)](https://semver.org/)\n\n![CI](https://github.com/SylvainDumas/setup-sonar-scanner/actions/workflows/ci.yml/badge.svg)\n[![Check dist/](https://github.com/SylvainDumas/setup-sonar-scanner/actions/workflows/check-dist.yml/badge.svg)](https://github.com/SylvainDumas/setup-sonar-scanner/actions/workflows/check-dist.yml)\n\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=SylvainDumas_setup-sonar-scanner\u0026metric=coverage)](https://sonarcloud.io/summary/new_code?id=SylvainDumas_setup-sonar-scanner)\n[![CodeQL](https://github.com/SylvainDumas/setup-sonar-scanner/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/SylvainDumas/setup-sonar-scanner/actions/workflows/github-code-scanning/codeql)\n[![GitHub Super-Linter](https://github.com/SylvainDumas/setup-sonar-scanner/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)\n\nThis Action sets up the Scanner CLI for SonarQube (Server, Cloud) for use in\nactions by:\n\n- Optionally downloading and caching distribution of the requested Scanner CLI\n  version, and adding it to the PATH\n- Registering problem matchers for error output.\n\nversion can be the `latest`, an\n[explicit](https://github.com/SonarSource/sonar-scanner-cli/releases) or a\n[semantic version range](https://github.com/npm/node-semver?tab=readme-ov-file#versions)\n\nYou can find source code of the Scanner CLI\n[here](https://github.com/SonarSource/sonar-scanner-cli)\n\n## Requirements\n\n- Node.js 20.19.0 or later (`\u003e=20.19.0`).\n- GitHub-hosted runners are supported and follow GitHub runtime evolution.\n\n## Usage\n\nMinimal (default use the latest version)\n\n```yml\n- uses: SylvainDumas/setup-sonar-scanner@v1\n```\n\nWith an explicit\n[version](https://github.com/SonarSource/sonar-scanner-cli/releases)\n\n```yml\n- uses: SylvainDumas/setup-sonar-scanner@v1\n  with:\n    version: '8.0.1.6346'\n```\n\nWith a\n[semantic version range](https://github.com/npm/node-semver?tab=readme-ov-file#versions)\n\n```yml\n- uses: SylvainDumas/setup-sonar-scanner@v1\n  with:\n    version: '8.x'\n```\n\n\u003e [!TIP]\n\u003e\n\u003e You can use expression like `7.x` or more complex like `\u003e=1.2.7 \u003c1.3.0`,\n\u003e `1.2.7 || \u003e=1.2.9 \u003c2.0.0`, ...\n\n## Inputs\n\n### version\n\n- **type**: string\n- **required**: false\n- **default**: `latest`\n- **description**: version of the Scanner CLI to install.\n  - latest\n  - [explicit](https://github.com/SonarSource/sonar-scanner-cli/releases)\n  - [semantic version range](https://github.com/npm/node-semver?tab=readme-ov-file#versions)\n\n\u003e [!WARNING]\n\u003e\n\u003e Minimum version supported: 3.x\n\n## Full Example usage\n\nYou can find additional informations in official SonarQube\n[documentation](https://docs.sonarsource.com/sonarqube-server/latest/devops-platform-integration/github-integration/adding-analysis-to-github-actions-workflow/).\n\n\u003c!-- prettier-ignore-start --\u003e\n\n```yaml\nname: SonarQube Workflow\n\non:\n  push:\n    branches:\n      - main # the name of your main branch\n  pull_request:\n    types: [opened, synchronize, reopened]\n\npermissions:\n  contents: read\n\njobs:\n  sonarqube-analysis:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v4\n        with:\n          fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis\n      # Setup sonar-scanner\n      - name: Setup SonarQube\n        uses: SylvainDumas/setup-sonar-scanner@v1\n      # Run sonar-scanner\n      - name: SonarQube Scan\n        run: sonar-scanner\n          -Dsonar.host.url=${{ secrets.SONAR_HOST_URL }}\n          -Dsonar.token=${{ secrets.SONAR_TOKEN }}\n          -Dsonar.organization=$GITHUB_REPOSITORY_OWNER\n          -Dsonar.projectKey=${{ secrets.SONAR_PROJECT_KEY }}\n```\n\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003e [!NOTE]\n\u003e\n\u003e Need to be adapted following your use cases (GitHub workflow permissions, test\n\u003e coverage generation, ...)\n\n## Other actions\n\n- \u003chttps://github.com/SonarSource/sonarqube-scan-action\u003e Official SonarQube\n  GitHub Action to install and run an analysis on your code, but doesn't allow\n  you to just install the Scanner CLI for SonarQube.\n- \u003chttps://github.com/Warchant/setup-sonar-scanner\u003e Another GitHub Action to\n  install the Scanner CLI for SonarQube, but no longer seems to be maintained.\n\n## License\n\nThe scripts and documentation in this project are released under the\n[MIT License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsylvaindumas%2Fsetup-sonar-scanner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsylvaindumas%2Fsetup-sonar-scanner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsylvaindumas%2Fsetup-sonar-scanner/lists"}