This repo is to set up the runner for updating docs at https://docs.cslant.com/
We can use this runner to update the docs automatically with CI/CD pipelines.
First, copy the .env.example
file to .env
and update the values.
envsubst < .env.example > .env
In the .env
file, update the values to match your environment.
# .env
SOURCE_DIR=/home/user/repo_dir
DOCS_REPO=git@github.com:cslant/docs.git
# The name of the docs repo
DOCS_NAME=main-docs
# The name of the runner
WORKER_NAME=cslant-docs
Important
- If the
SOURCE_DIR
is wrong, the runner will not be able to find the source code. So, please make sure theSOURCE_DIR
is correct.
Then, run the following command to start the runner.
bash runner.sh all
The runner has the following commands:
Command | Description |
---|---|
help |
Shows the help message |
build |
Builds the docs |
worker |
Create or restart the worker |
all |
Runs all the commands |