{"id":17656643,"url":"https://github.com/straight-shoota/autodeploy-docs","last_synced_at":"2025-03-30T09:43:25.092Z","repository":{"id":148193558,"uuid":"97499990","full_name":"straight-shoota/autodeploy-docs","owner":"straight-shoota","description":"Automatically deploy documentation for your code repositories","archived":false,"fork":false,"pushed_at":"2018-10-09T19:29:22.000Z","size":13,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-05T11:45:52.122Z","etag":null,"topics":["ci","continuous-integration","documentation-tool","git-deploy"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/straight-shoota.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":"2017-07-17T16:47:04.000Z","updated_at":"2018-10-09T19:29:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"9060033e-3336-4858-b106-cfec948c9938","html_url":"https://github.com/straight-shoota/autodeploy-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/straight-shoota%2Fautodeploy-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/straight-shoota%2Fautodeploy-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/straight-shoota%2Fautodeploy-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/straight-shoota%2Fautodeploy-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/straight-shoota","download_url":"https://codeload.github.com/straight-shoota/autodeploy-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246301953,"owners_count":20755512,"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":["ci","continuous-integration","documentation-tool","git-deploy"],"created_at":"2024-10-23T14:35:15.148Z","updated_at":"2025-03-30T09:43:25.070Z","avatar_url":"https://github.com/straight-shoota.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# autodeploy-docs\nAutomatically deploy documentation for your code repositories.\n\nThis script does the following:\n* clone the docs repository (`DOCS_REPO`, `DOCS_BRANCH`) into a working dir (`WORKDIR`)\n* collect documentation from a source directory (`GENERATE_DOCS_DIR`) into a target path in the repository (`TARGET_PATH`)\n* commit updates to repository (`GIT_COMMIT_MESSAGE`, `GIT_COMMITTER_NAME`, `GIT_COMMITTER_EMAIL`)\n* push local repository to origin\n\nIt can be invoked as an after_success hook on a CI setup or run manually.\nMost configuration values will work with their default values on Travis-CI or when run from a local copy of\na repository at Github. They can also be customized trough environment variables.\n\n# Installation\n\n```\n# run once (for example in CI):\ncurl https://raw.githubusercontent.com/straight-shoota/autodeploy-docs/master/autodeploy-docs.sh | bash\n# install locally\ncurl https://raw.githubusercontent.com/straight-shoota/autodeploy-docs/master/autodeploy-docs.sh \u003e /usr/local/bin/autodeploy-docs\n```\n\n## Usage\n\nlocal manual run:\n```bash\ncreate_documentation \u0026\u0026 autodeploy-docs\n```\n\nOn travis-CI ([real-world example](https://github.com/straight-shoota/crinja/blob/fcf4e65f9db86fe853176a6b9ce843d4bf17d6e2/.travis.yml))\n```yaml\nafter_success:\n- generate_documentation\n- curl https://raw.githubusercontent.com/straight-shoota/autodeploy-docs/master/autodeploy-docs.sh | bash\n\nenv:\n  global:\n    GIT_COMMITTER_NAME: travis-ci\n    GIT_COMMITTER_EMAIL: travis@travis-ci.org\n```\nYou need to install an ssh key on travis or define a secret environment variable `GH_TOKEN` with a token to push to Github API.\n\n\n\n# Configuration\n\n* **`GENERATED_DOCS_DIR`:** `$(pwd)/doc`\n* **`BRANCH`:** `$TRAVIS_BRANCH` or `$(git rev-parse --abbrev-ref HEAD)`\n* **`TAG`:** `$TRAVIS_TAG` or `$(git name-rev --tags --name-only \"${BRANCH}\")` or `latest`\n* **`REPO`:** `$TRAVIS_REPO_SLUG` or `$(git ls-remote --get-url origin)`\n* **`WORKDIR`:** `${HOME}/${REPO}-docs-${TAG}`\n* **`DOCS_REPO`:** `https://${GH_TOKEN}@github.com/${REPO}` or `git@github.com:${REPO}`\n* **`DOCS_BRANCH`:** `gh-pages`\n* **`GH_TOKEN`:** (needs to be set if no ssh key is available)\n* **`TARGET_PATH`:** `api/${TAG}`\n\n## Contributing\n\n1. Fork it ( https://github.com/straight-shoota/autodeploy-docs/fork )\n2. Create your feature branch (git checkout -b my-new-feature)\n3. Commit your changes (git commit -am 'Add some feature')\n4. Push to the branch (git push origin my-new-feature)\n5. Create a new Pull Request\n\n## Contributors\n\n- [straight-shoota](https://github.com/straight-shoota) Johannes Müller - creator, maintainer\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstraight-shoota%2Fautodeploy-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstraight-shoota%2Fautodeploy-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstraight-shoota%2Fautodeploy-docs/lists"}