Add Docker image instructions
Signed-off-by: Steven Kriegler <sk.bunsenbrenner@gmail.com>
This commit is contained in:
parent
7f68b52076
commit
e4ff25a193
|
@ -48,6 +48,13 @@ For local purposes
|
||||||
docker build -t gitea-sonarqube-pr-bot/prod .
|
docker build -t gitea-sonarqube-pr-bot/prod .
|
||||||
```
|
```
|
||||||
|
|
||||||
|
For actual release builds
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker build -t justusbunsi/gitea-sonarqube-bot:$TAG .
|
||||||
|
docker push justusbunsi/gitea-sonarqube-bot:$TAG
|
||||||
|
```
|
||||||
|
|
||||||
## Developer Certificate of Origin (DCO)
|
## Developer Certificate of Origin (DCO)
|
||||||
|
|
||||||
I consider the act of contributing to the code by submitting a Pull Request as the "Sign off" or agreement to the
|
I consider the act of contributing to the code by submitting a Pull Request as the "Sign off" or agreement to the
|
||||||
|
|
14
README.md
14
README.md
|
@ -1,6 +1,7 @@
|
||||||
# Gitea SonarQube Bot
|
# Gitea SonarQube Bot
|
||||||
|
|
||||||
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gitea-sonarqube-bot&metric=alert_status)](https://sonarcloud.io/dashboard?id=gitea-sonarqube-bot)
|
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gitea-sonarqube-bot&metric=alert_status)](https://sonarcloud.io/dashboard?id=gitea-sonarqube-bot)
|
||||||
|
![Docker Image Version (latest semver)](https://img.shields.io/docker/v/justusbunsi/gitea-sonarqube-bot?logo=docker)
|
||||||
|
|
||||||
_Gitea SonarQube Bot_ is a bot that receives messages from both SonarQube and Gitea to help developers
|
_Gitea SonarQube Bot_ is a bot that receives messages from both SonarQube and Gitea to help developers
|
||||||
being productive. The idea behind this project is the missing ALM integration of Gitea in SonarQube. Unfortunately,
|
being productive. The idea behind this project is the missing ALM integration of Gitea in SonarQube. Unfortunately,
|
||||||
|
@ -12,6 +13,8 @@ Luckily, both endpoints have a proper REST API to communicate with each others.
|
||||||
- [Workflow](#workflow)
|
- [Workflow](#workflow)
|
||||||
- [Requirements](#requirements)
|
- [Requirements](#requirements)
|
||||||
- [Bot configuration](#bot-configuration)
|
- [Bot configuration](#bot-configuration)
|
||||||
|
- [Installation](#installation)
|
||||||
|
- [Docker](#docker)
|
||||||
- [Setup](#setup)
|
- [Setup](#setup)
|
||||||
- [SonarQube](#sonarqube)
|
- [SonarQube](#sonarqube)
|
||||||
- [Gitea](#gitea)
|
- [Gitea](#gitea)
|
||||||
|
@ -44,6 +47,17 @@ This bot is designed to perform SonarQube/SonarCloud API requests specific for p
|
||||||
|
|
||||||
See [config.example.yaml](config/config.example.yaml) for a full configuration specification and description.
|
See [config.example.yaml](config/config.example.yaml) for a full configuration specification and description.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
### Docker
|
||||||
|
|
||||||
|
Create a directory `config` and place your [config.yaml](config/config.example.yaml) inside it. Open a terminal next to this directory
|
||||||
|
and execute the following (replace `$TAG` first):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker run --rm -it -p 9000:3000 -v "$(pwd)/config/:/home/bot/config/" justusbunsi/gitea-sonarqube-bot:$TAG
|
||||||
|
```
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
### SonarQube
|
### SonarQube
|
||||||
|
|
Loading…
Reference in a new issue