{"id":15018155,"url":"https://github.com/kengotoda/readthedocs-action","last_synced_at":"2025-09-05T05:42:24.712Z","repository":{"id":37603143,"uuid":"147175202","full_name":"KengoTODA/readthedocs-action","owner":"KengoTODA","description":"An unofficial GitHub Probot that helps reviewing on Read the Docs","archived":false,"fork":false,"pushed_at":"2023-02-28T11:58:14.000Z","size":12585,"stargazers_count":9,"open_issues_count":10,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-15T05:20:51.125Z","etag":null,"topics":["github-actions","probot","readthedocs","rtd","sphinx"],"latest_commit_sha":null,"homepage":"https://github.com/apps/rtd-helper","language":"TypeScript","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/KengoTODA.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"KengoTODA"}},"created_at":"2018-09-03T08:33:02.000Z","updated_at":"2023-06-14T17:17:50.000Z","dependencies_parsed_at":"2024-09-12T03:30:08.974Z","dependency_job_id":"2052c812-7fcb-403f-957d-1157ca684d0e","html_url":"https://github.com/KengoTODA/readthedocs-action","commit_stats":{"total_commits":881,"total_committers":9,"mean_commits":97.88888888888889,"dds":0.6765039727582293,"last_synced_commit":"b877a0c97485376d7b531a91f7b61374aa64c813"},"previous_names":["kengotoda/rtd-bot"],"tags_count":63,"template":false,"template_full_name":null,"purl":"pkg:github/KengoTODA/readthedocs-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KengoTODA%2Freadthedocs-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KengoTODA%2Freadthedocs-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KengoTODA%2Freadthedocs-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KengoTODA%2Freadthedocs-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KengoTODA","download_url":"https://codeload.github.com/KengoTODA/readthedocs-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KengoTODA%2Freadthedocs-action/sbom","scorecard":{"id":77797,"data":{"date":"2025-08-11","repo":{"name":"github.com/KengoTODA/readthedocs-action","commit":"b877a0c97485376d7b531a91f7b61374aa64c813"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/11 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":0,"reason":"dangerous workflow patterns detected","details":["Warn: untrusted code checkout '${{ github.event.workflow_run.head_sha }}': .github/workflows/test-with-tokens.yml:15"],"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/build.yml:1","Warn: no topLevel permission defined: .github/workflows/integration-test.yml:1","Warn: no topLevel permission defined: .github/workflows/test-with-tokens.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":5,"reason":"dependency not pinned by hash detected -- score normalized to 5","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/KengoTODA/readthedocs-action/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/KengoTODA/readthedocs-action/build.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/integration-test.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/KengoTODA/readthedocs-action/integration-test.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-with-tokens.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/KengoTODA/readthedocs-action/test-with-tokens.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-with-tokens.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/KengoTODA/readthedocs-action/test-with-tokens.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-with-tokens.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/KengoTODA/readthedocs-action/test-with-tokens.yml/main?enable=pin","Info:   0 out of   5 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   2 out of   2 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 22 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"23 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j","Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-15T05:12:41.926Z","repository_id":37603143,"created_at":"2025-08-15T05:12:41.926Z","updated_at":"2025-08-15T05:12:41.926Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273717895,"owners_count":25155482,"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","status":"online","status_checked_at":"2025-09-05T02:00:09.113Z","response_time":402,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["github-actions","probot","readthedocs","rtd","sphinx"],"created_at":"2024-09-24T19:51:34.304Z","updated_at":"2025-09-05T05:42:24.686Z","avatar_url":"https://github.com/KengoTODA.png","language":"TypeScript","funding_links":["https://github.com/sponsors/KengoTODA"],"categories":[],"sub_categories":[],"readme":"# Get the staging document in PR\n\n![](https://github.com/KengoTODA/readthedocs-action/workflows/.github/workflows/build.yml/badge.svg)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-908a85?logo=gitpod)](https://gitpod.io/#https://github.com/KengoTODA/readthedocs-action)\n\nWork with Read the Docs, then you'll find that PR for documentation needs additional steps like:\n\n- running RTD build for your branch manually, to use its result as staging site [like this](https://github.com/spotbugs/spotbugs/pull/697#issue-201455071), or\n- sharing screenshot to share the updated document [like this](https://github.com/spotbugs/spotbugs/pull/718#issue-205904835).\n\nThis GitHub Action automates the first approach; activate RTD build automatically when you made PR that updates the document.\n\n![screenshot](screenshot.png)\n\n## How to use\n\nFrom v2, this system only works as a GitHub Action. v1 worked as a service (GitHub Probot) too.\n\n### Initial setup\n\n0. Make sure that your RTD project has been [connected with GitHub repository](https://docs.readthedocs.io/en/latest/getting_started.html#sign-up-and-connect-an-external-account), or [integrated via GitHub webhook](https://docs.readthedocs.io/en/latest/webhooks.html#github).\n1. Add a step to your GitHub Actions workflow. Here is a sample `.github/workflows/build.yml`:\n\n```yml\nname: Documentation\non:\n  pull_request_target:\n    paths:\n      - \"docs/**\"\n    types:\n      - opened\n      - reopened\n      - synchronize\n      - closed # necessary to deactivate the version in Read the Docs\npermissions:\n  pull-requests: write\n  checks: write\njobs:\n  staging:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Deploy to the staging site\n        uses: KengoTODA/readthedocs-action@main\n        with:\n          github-token: ${{ secrets.GITHUB_TOKEN }}\n          rtd-token: ${{ secrets.RTD_TOKEN }}\n          rtd-project: your-read-the-docs-project\n```\n\nHere `secrets.RTD_TOKEN` is the token issued by [Read the Docs](https://readthedocs.org/). See [official doc](https://docs.readthedocs.io/en/stable/api/v3.html#token) for detail.\n\n## Advanced Configuration\n\n### Configuration for the project with translations\n\nIf you use [translations feature](https://docs.readthedocs.io/en/latest/localization.html#project-with-multiple-translations), make sure you've configured all your RTD projects including translations.\n\nSet the project slug of the root RTD project to `project` config.\n\n## Migrating from v1 to v2\n\n1. Uninstall the [GitHub App](https://github.com/settings/apps/rtd-helper) from your repository.\n2. Remove the`.github/config.yml` file that is no longer needed.\n3. Set one GitHub Secrets `RTD_TOKEN`, and\n4. Create a GitHub Actions workflow file to run the Action.\n5. Stop inviting the `rtd-bot` RTD account as maintainer.\n\n## Alternative Solutions\n\nFrom 2021 Feb, [Read the Docs officially provides the Pull Request Builders](https://blog.readthedocs.com/pull-request-builder-general-availability/).\n\n## License\n\nCopyright \u0026copy; 2018-2022 Kengo TODA\n\n```\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n\nThe RTD Helper's avatar is designed by [MAM2](https://dribbble.com/MAM2).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkengotoda%2Freadthedocs-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkengotoda%2Freadthedocs-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkengotoda%2Freadthedocs-action/lists"}