Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elgohr/concourse-sonarqube-notifier
Concourse CI Resource for getting results from Sonarqube.
https://github.com/elgohr/concourse-sonarqube-notifier
concourse concourse-ci concourse-ci-resource sonarqube
Last synced: 2 months ago
JSON representation
Concourse CI Resource for getting results from Sonarqube.
- Host: GitHub
- URL: https://github.com/elgohr/concourse-sonarqube-notifier
- Owner: elgohr
- License: mit
- Created: 2018-04-07T19:34:33.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T18:29:29.000Z (4 months ago)
- Last Synced: 2024-10-10T18:46:47.562Z (3 months ago)
- Topics: concourse, concourse-ci, concourse-ci-resource, sonarqube
- Language: Go
- Homepage:
- Size: 11.5 MB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SonarQube Notification Resource
[](https://github.com/elgohr/concourse-sonarqube-notifier/actions/workflows/test.yml)
[](https://github.com/elgohr/concourse-sonarqube-notifier/actions/workflows/publish.yml)
Gets Sonarqube results.
## Installing
`Shortcut`: [Pipeline example](https://github.com/elgohr/concourse-sonarqube-notifier/blob/master/example-pipeline.yml)
Use this resource by adding the following to
the `resource_types` section of a pipeline config:
```yaml
---
resource_types:
- name: sonarqube-notifier
type: docker-image
source:
repository: lgohr/sonarqube
tag: latest
```
## Source configuration
Configure as follows:
```yaml
---
resources:
- name: my-sonarqube
type: sonarqube-notifier
source:
target: https://my.sonar.server
sonartoken: ((my-secret-token))
component: my:component
metrics: ncloc,complexity,violations,coverage
```
* `target`: *Required.* URL of your SonarQube instance e.g. `https://my-atlassian.com/sonar`.
* `sonartoken`: *Required.* [Security token](https://docs.sonarqube.org/display/SONAR/User+Token), which is used to connect to Sonarqube.
* `component`: *Required.* The component _key_ of your component. This is shown in the dashboard url as https://my-atlassian/sonar/dashboard?id=ComponentKey
* `metrics`: *Required.* The metrics you want to grab. See https://docs.sonarqube.org/display/SONAR/Metric+Definitions
## `in`: Get the latest result
Get the latest result; write it to the local working directory (e.g.
`/tmp/build/get`) with the filename result.json.
Example response (metrics: nloc,complexity,violations,coverage)
```json
{
"component": {
"id": "AWH_6osdce3G0HojaCW1",
"key": "my:component",
"name": "my-component",
"qualifier": "TRK",
"measures": [
{
"metric": "ncloc",
"value": "824",
"periods": [
{
"index": 1,
"value": "299"
}
]
},
{
"metric": "complexity",
"value": "90",
"periods": [
{
"index": 1,
"value": "27"
}
]
},
{
"metric": "violations",
"value": "5",
"periods": [
{
"index": 1,
"value": "-6"
}
]
},
{
"metric": "coverage",
"value": "91.4",
"periods": [
{
"index": 1,
"value": "40.7"
}
]
}
]
},
"periods": [
{
"index": 1,
"mode": "previous_version",
"date": "2018-03-07T16:58:31+0100"
}
]
}
```
## `out`: Nothing