From 4ca5ed733c723e7dc71dd0b54def2316a7a6e3ad Mon Sep 17 00:00:00 2001 From: moanos Date: Fri, 4 Oct 2024 11:08:49 +0200 Subject: [PATCH] ci: Secret config --- .woodpecker.yml | 5 ++++- docs/README.md | 12 +++++++++++- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/.woodpecker.yml b/.woodpecker.yml index 1eca023..42b0e78 100644 --- a/.woodpecker.yml +++ b/.woodpecker.yml @@ -3,11 +3,14 @@ steps: create_docker_image: image: woodpeckerci/plugin-docker-buildx - secrets: [ docker_username, docker_password ] settings: repo: moanos/sphinx-rtd dockerfile: docs/Dockerfile tag: latest + username: + from_secret: docker_username + password: + from_secret: docker_password build: image: moanos/sphinx-rtd diff --git a/docs/README.md b/docs/README.md index 77416af..03b88ff 100644 --- a/docs/README.md +++ b/docs/README.md @@ -86,4 +86,14 @@ docker run --rm -v ./docs:/docs sphinx-rtd make html # CI -Woodpecker can be used to deploy the documentation to a server \ No newline at end of file +Woodpecker can be used to deploy the documentation to a server. Fo that purpose it builds a docker container that contains +sphinx and the read-the-docs theme, builds the documentation with that and pushes it to a server which will serve the static files. + +| Key | Example | Description | +|-------------------|-------------------------------------------------------------|-------------------------------------------------------------| +| `host` | `dokumentation.notfellchen.org` | Hostename of the server where you want to deploy | +| `ssh_user` | `username` | User on the server | +| `ssh_key` | `-----BEGIN OPENSSH PRIVATE KEY-----` | The private SSH key of the user | +| `path` | `/static_sites/static-hyteck/dokumentation.notfellchen.org` | Path where to deploy the static files. | +| `docker_username` | `moanos` | Username authenticate to dockerhub to push the docker image | +| `docker_password` | `SUPERSECRET` | Password authenticate to dockerhub to push the docker image |