This commit is contained in:
parent
61cee697e4
commit
4ca5ed733c
@ -3,11 +3,14 @@
|
|||||||
steps:
|
steps:
|
||||||
create_docker_image:
|
create_docker_image:
|
||||||
image: woodpeckerci/plugin-docker-buildx
|
image: woodpeckerci/plugin-docker-buildx
|
||||||
secrets: [ docker_username, docker_password ]
|
|
||||||
settings:
|
settings:
|
||||||
repo: moanos/sphinx-rtd
|
repo: moanos/sphinx-rtd
|
||||||
dockerfile: docs/Dockerfile
|
dockerfile: docs/Dockerfile
|
||||||
tag: latest
|
tag: latest
|
||||||
|
username:
|
||||||
|
from_secret: docker_username
|
||||||
|
password:
|
||||||
|
from_secret: docker_password
|
||||||
|
|
||||||
build:
|
build:
|
||||||
image: moanos/sphinx-rtd
|
image: moanos/sphinx-rtd
|
||||||
|
@ -86,4 +86,14 @@ docker run --rm -v ./docs:/docs sphinx-rtd make html
|
|||||||
|
|
||||||
# CI
|
# CI
|
||||||
|
|
||||||
Woodpecker can be used to deploy the documentation to a server
|
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 |
|
||||||
|
Loading…
Reference in New Issue
Block a user