From 005433abeedb3212741afeaefac4567f663cd41a Mon Sep 17 00:00:00 2001 From: kjuulh Date: Tue, 8 Aug 2023 16:01:26 +0200 Subject: [PATCH] docs(README): added some more milestones and fixed docker-compose Signed-off-by: kjuulh --- README.md | 79 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 52 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index ddbe1e2..f1e4f61 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,31 @@ # Contractor - A renovate bot for gitea and github -Contractor is a chatops like bot, integrating with github/gitea issues, allowing commands to trigger renovate runs. +Contractor is a chatops like bot, integrating with github/gitea issues, allowing +commands to trigger renovate runs. ```bash -/contractor refresh +/contractor refresh ``` -Contractor runs in a regular docker image and uses the official renovate slim image behind the scenes, this can be changed in the configuration. +Contractor runs in a regular docker image and uses the official renovate slim +image behind the scenes, this can be changed in the configuration. ![command](./assets/command.png) -Do note that the contractor was run under a personal user, hence the same user replied +Do note that the contractor was run under a personal user, hence the same +user replied ## DISCLAIMER -The project is still 0.x.x As such the api is subject to change, and the examples will probably be out of date. The below should be seen as an example of what the project will look like once feature-complete. +The project is still 0.x.x As such the api is subject to change, and the +examples will probably be out of date. The below should be seen as an example of +what the project will look like once feature-complete. ## Milestones - [x] 0.1.0 - - Includes basic setup such as working server bot, and installation command, automation is missing however. Also only gitea support for now, because this is where the project initially is supposed to be in use. + - Includes basic setup such as working server bot, and installation command, + automation is missing however. Also only gitea support for now, because this + is where the project initially is supposed to be in use. - [ ] 0.2.0 - Add GitHub support - [ ] 0.3.0 @@ -27,12 +34,16 @@ The project is still 0.x.x As such the api is subject to change, and the example - Slack integration - [ ] 0.5.0 - GitHub App and such support +- [ ] 0.6.0 + - Add api key support ## Getting started -First you need to pull and run the contractor image, docker is the preferred way of execution, but golang is also available from source. +First you need to pull and run the contractor image, docker is the preferred way +of execution, but golang is also available from source. -Docker compose is given as an example, but you're free to run using `docker run` if you prefer. +Docker compose is given as an example, but you're free to run using `docker run` +if you prefer. See example for a ready-to-run image @@ -41,18 +52,17 @@ See example for a ready-to-run image version: "3" services: contractor: - image: docker.io/kjuulh/contractor:latest - restart: unless-stopped - commands: - - contractor server serve - volumes: - - "./templates/contractor:/mnt/config" - - "/var/run/docker.sock:/var/run/docker.sock" - env_file: - - .env + image: docker.io/kjuulh/contractor:latest + restart: unless-stopped + commands: + - contractor server serve + volumes: + - "./templates/contractor:/mnt/config" + - "/var/run/docker.sock:/var/run/docker.sock" + env_file: + - .env ``` - ```bash # file: .env GITEA_RENOVATE_TOKEN= # needs repo and pull request permissions @@ -74,28 +84,37 @@ CONTRACTOR_API_KEY='