Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cslant/docs-runner
This repo is to setup the runner for updating docs at https://docs.cslant.com
https://github.com/cslant/docs-runner
cslant cslant-cicd cslant-docs cslant-documations cslant-github cslant-runner docs docs-runner runner
Last synced: 14 days ago
JSON representation
This repo is to setup the runner for updating docs at https://docs.cslant.com
- Host: GitHub
- URL: https://github.com/cslant/docs-runner
- Owner: cslant
- License: mit
- Created: 2024-04-26T04:01:40.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-12-18T18:30:12.000Z (20 days ago)
- Last Synced: 2024-12-18T19:37:21.964Z (20 days ago)
- Topics: cslant, cslant-cicd, cslant-docs, cslant-documations, cslant-github, cslant-runner, docs, docs-runner, runner
- Language: Shell
- Homepage: https://docs.cslant.com
- Size: 43.9 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CSlant Docs Runner
```text
██████╗███████╗██╗ █████╗ ███╗ ██╗████████╗ ██████╗ ██████╗ ██████╗███████╗
██╔════╝██╔════╝██║ ██╔══██╗████╗ ██║╚══██╔══╝ ██╔══██╗██╔═══██╗██╔════╝██╔════╝
██║ ███████╗██║ ███████║██╔██╗ ██║ ██║ ██║ ██║██║ ██║██║ ███████╗
██║ ╚════██║██║ ██╔══██║██║╚██╗██║ ██║ ██║ ██║██║ ██║██║ ╚════██║
╚██████╗███████║███████╗██║ ██║██║ ╚████║ ██║ ██████╔╝╚██████╔╝╚██████╗███████║
╚═════╝╚══════╝╚══════╝╚═╝ ╚═╝╚═╝ ╚═══╝ ╚═╝ ╚═════╝ ╚═════╝ ╚═════╝╚══════╝
```
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.
## Installation
First, copy the `.env.example` file to `.env` and update the values.
```bash
envsubst < .env.example > .env
```
In the `.env` file, update the values to match your environment.
```bash
# .env
SOURCE_DIR=/home/user/repo_dir
[email protected]:cslant
# cslant/docs.git
DOCS_REPO=docs
#DOCS_NAME=docusaurus-docs
DOCS_NAME=main-docs
# The name of the runner
WORKER_NAME=cslant-docs
# add the env to choose "npm" or "yarn" as the installer
INSTALLER=yarn
PORT=3000
```
> [!IMPORTANT]
> ## Command can't be used if wrong values are set in the `.env` file.
> * If the `SOURCE_DIR` is wrong, the runner will not be able to find the source code. So, please make sure the `SOURCE_DIR` is correct.
Then, run the following command to start the runner.
```bash
bash runner.sh all
```
## Usage
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 |