{"id":23462001,"url":"https://github.com/cslant/docs-runner","last_synced_at":"2025-04-12T06:58:39.973Z","repository":{"id":236793682,"uuid":"792140014","full_name":"cslant/docs-runner","owner":"cslant","description":"This repo is to setup the runner for updating docs at https://docs.cslant.com","archived":false,"fork":false,"pushed_at":"2025-03-13T17:16:00.000Z","size":54,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-12T06:58:36.397Z","etag":null,"topics":["cslant","cslant-cicd","cslant-docs","cslant-documations","cslant-github","cslant-runner","docs","docs-runner","runner"],"latest_commit_sha":null,"homepage":"https://docs.cslant.com","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cslant.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-26T04:01:40.000Z","updated_at":"2025-03-13T17:16:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"72590199-ebe4-4551-896c-cf16b9fcaf38","html_url":"https://github.com/cslant/docs-runner","commit_stats":null,"previous_names":["cslant/docs-runner"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cslant%2Fdocs-runner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cslant%2Fdocs-runner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cslant%2Fdocs-runner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cslant%2Fdocs-runner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cslant","download_url":"https://codeload.github.com/cslant/docs-runner/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248530578,"owners_count":21119595,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cslant","cslant-cicd","cslant-docs","cslant-documations","cslant-github","cslant-runner","docs","docs-runner","runner"],"created_at":"2024-12-24T08:15:25.791Z","updated_at":"2025-04-12T06:58:39.955Z","avatar_url":"https://github.com/cslant.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CSlant Docs Runner\n\n```text\n ██████╗███████╗██╗      █████╗ ███╗   ██╗████████╗    ██████╗  ██████╗  ██████╗███████╗\n██╔════╝██╔════╝██║     ██╔══██╗████╗  ██║╚══██╔══╝    ██╔══██╗██╔═══██╗██╔════╝██╔════╝\n██║     ███████╗██║     ███████║██╔██╗ ██║   ██║       ██║  ██║██║   ██║██║     ███████╗\n██║     ╚════██║██║     ██╔══██║██║╚██╗██║   ██║       ██║  ██║██║   ██║██║     ╚════██║\n╚██████╗███████║███████╗██║  ██║██║ ╚████║   ██║       ██████╔╝╚██████╔╝╚██████╗███████║\n ╚═════╝╚══════╝╚══════╝╚═╝  ╚═╝╚═╝  ╚═══╝   ╚═╝       ╚═════╝  ╚═════╝  ╚═════╝╚══════╝\n```\n\nThis repo is to set up the runner for updating docs at https://docs.cslant.com\n\nWe can use this runner to update the docs automatically with CI/CD pipelines.\n\n\u003cimg src=\"https://github.com/cslant/docs/blob/main/static/img/cslant-docs-runner.webp\" alt=\"CSlant docs runner\"\u003e\n\n## Installation\n\nFirst, copy the `.env.example` file to `.env` and update the values.\n\n```bash\nenvsubst \u003c .env.example \u003e .env\n```\n\nIn the `.env` file, update the values to match your environment.\n\n```bash\n# .env\n\nSOURCE_DIR=/home/user/repo_dir\n\nGIT_SSH_URL=git@github.com:cslant\n\n# cslant/docs.git\nDOCS_REPO=docs\n\n#DOCS_NAME=docusaurus-docs\nDOCS_NAME=main-docs\n\n# The name of the runner\nWORKER_NAME=cslant-docs\n\n# add the env to choose \"npm\" or \"yarn\" as the installer\nINSTALLER=yarn\nPORT=3000\n```\n\n\u003e [!IMPORTANT]\n\u003e ## Command can't be used if wrong values are set in the `.env` file.\n\u003e * 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.\n\nThen, run the following command to start the runner.\n\n```bash\nbash runner.sh all\n```\n\n## Usage\n\nThe runner has the following commands:\n\n| Command  | Description                  |\n|----------|------------------------------|\n| `help`   | Shows the help message       |\n| `build`  | Builds the docs              |\n| `worker` | Create or restart the worker |\n| `all`    | Runs all the commands        |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcslant%2Fdocs-runner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcslant%2Fdocs-runner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcslant%2Fdocs-runner/lists"}