Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cslant/home-runner
This repo is to setup the runner for updating the homepage at https://cslant.com
https://github.com/cslant/home-runner
cslant cslant-cicd cslant-github cslant-runner deploy homepage runner
Last synced: 14 days ago
JSON representation
This repo is to setup the runner for updating the homepage at https://cslant.com
- Host: GitHub
- URL: https://github.com/cslant/home-runner
- Owner: cslant
- License: mit
- Created: 2024-10-30T15:17:22.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-15T09:15:24.000Z (23 days ago)
- Last Synced: 2024-12-15T10:24:26.109Z (23 days ago)
- Topics: cslant, cslant-cicd, cslant-github, cslant-runner, deploy, homepage, runner
- Language: Shell
- Homepage: https://cslant.com
- Size: 28.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CSlant Home Runner
```text
██╗ ██╗ ██████╗ ███╗ ███╗███████╗ ██████╗ ██╗ ██╗███╗ ██╗███╗ ██╗███████╗██████╗
██║ ██║██╔═══██╗████╗ ████║██╔════╝ ██╔══██╗██║ ██║████╗ ██║████╗ ██║██╔════╝██╔══██╗
███████║██║ ██║██╔████╔██║█████╗ ██████╔╝██║ ██║██╔██╗ ██║██╔██╗ ██║█████╗ ██████╔╝
██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ██╔══██╗██║ ██║██║╚██╗██║██║╚██╗██║██╔══╝ ██╔══██╗
██║ ██║╚██████╔╝██║ ╚═╝ ██║███████╗ ██║ ██║╚██████╔╝██║ ╚████║██║ ╚████║███████╗██║ ██║
╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝╚══════╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝╚═╝ ╚═══╝╚══════╝╚═╝ ╚═╝
```
This repo is to set up the runner for updating the homepage at https://cslant.com
We can use this runner to update the Home automatically with CI/CD pipelines.
## Installation
First, copy the `.env.example` file to `.env` and update the values.
```bash
envsubst < .env.example > .env
```
If you don't have `envsubst` command, you can use the following command:
```bash
cp .env.example .env
```
In the `.env` file, update the values to match your environment.
```bash
# .env
#SOURCE_DIR=~/source
SOURCE_DIR=/home/user/cslant.com/home
[email protected]:cslant
# The name of the runner
WORKER_NAME="CSlant Home"
# add the env to choose "npm" or "yarn" as the installer
INSTALLER=yarn
# App Config
# E.g: prod, dev
ENV=prod
NODE_VERSION=22
USE_SUBMODULES=false
```
> [!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, you can just run the following command to start the runner.
```bash
./runner.sh a
```
## Usage
The runner has the following commands:
| Command | Description |
|----------------|------------------------------|
| `help`, `tips` | Shows the help message |
| `build`, `b` | Builds the Home |
| `worker`, `w` | Create or restart the worker |
| `all`, `a` | Runs all the commands |