2martens/terraform-drone-plugin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
Jim Martens
2023-10-31 13:02:03 +01:00
parent b780b891ed
commit fa2a34ce03
1 changed files with 13 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -1,30 +1,21 @@
# Qodana JVM Community Drone plugin # Terraform Drone plugin
[![Apache 2.0 License](https://img.shields.io/github/license/2martens/qodana-jvm-community-drone-plugin?label=License)](https://github.com/2martens/qodana-jvm-community-drone-plugin/blob/master/LICENSE) [![Apache 2.0 License](https://img.shields.io/github/license/2martens/terraform-drone-plugin?label=License)](https://github.com/2martens/terraform-drone-plugin/blob/main/LICENSE)
[![Docker image version](https://img.shields.io/docker/v/2martens/qodana-jvm-community-drone-plugin?logo=docker&label=Docker+image)](https://hub.docker.com/r/2martens/qodana-jvm-community-drone-plugin) [![Docker image version](https://img.shields.io/docker/v/2martens/terraform-drone-plugin?logo=docker&label=Docker+image)](https://hub.docker.com/r/2martens/terraform-drone-plugin)
This Drone plugin uses the Qodana JVM Community linter and makes it compatible with Drone. This Drone plugin uses the Terraform CLI and makes it compatible with Drone.
# Usage # Usage
```yaml ```yaml
- name: Step name - name: Step name
image: 2martens/qodana-jvm-community-drone-plugin image: 2martens/terraform-drone-plugin
settings: settings:
qodana_token: <qodana-cloud-token>
args: <args> args: <args>
``` ```
To use the quality gate feature, add `--fail-threshold <number>` to the args setting.
To use baseline feature, add `--baseline qodana.sarif.json` to the args setting.
This file has to be checked-in to the root of your project.
# Example pipeline # Example pipeline
This example pipeline uses host volumes and has to be trusted. The Qodana docker stores the cache
under /data/cache in the container and this pipeline makes sure that this cache is stored on the
host instead.
```yaml ```yaml
kind: pipeline kind: pipeline
@ -39,19 +30,14 @@ clone:
skip_verify: true skip_verify: true
steps: steps:
- name: run code analysis - name: login to Terraform cloud
pull: always pull: always
image: 2martens/qodana-jvm-community-drone-plugin:2023.2 image: 2martens/terraform-drone-plugin:1.26.2
settings: settings:
qodana_token: args: login
from_secret: qodana_token - name: run plan
args: --baseline qodana.sarif.json --fail-threshold 0 pull: always
volumes: image: 2martens/terraform-drone-plugin:1.26.2
- name: cache settings:
path: /data/cache args: plan
volumes:
- name: cache
host:
path: /var/lib/drone/cache
``` ```