{"id":29022770,"url":"https://github.com/tiryoh/actions-mkdocs","last_synced_at":"2025-10-09T04:40:07.200Z","repository":{"id":41865741,"uuid":"321097310","full_name":"Tiryoh/actions-mkdocs","owner":"Tiryoh","description":"⚙️ GitHub Actions for MkDocs","archived":false,"fork":false,"pushed_at":"2025-08-12T05:57:24.000Z","size":308,"stargazers_count":10,"open_issues_count":4,"forks_count":9,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-28T15:48:55.510Z","etag":null,"topics":["actions","github-pages","mkdocs"],"latest_commit_sha":null,"homepage":"","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/Tiryoh.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"zenodo":null}},"created_at":"2020-12-13T15:31:53.000Z","updated_at":"2025-05-14T01:41:08.000Z","dependencies_parsed_at":"2024-06-20T19:07:03.017Z","dependency_job_id":"45608dcd-475e-40cc-b21b-30358775c29a","html_url":"https://github.com/Tiryoh/actions-mkdocs","commit_stats":null,"previous_names":[],"tags_count":48,"template":false,"template_full_name":null,"purl":"pkg:github/Tiryoh/actions-mkdocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tiryoh%2Factions-mkdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tiryoh%2Factions-mkdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tiryoh%2Factions-mkdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tiryoh%2Factions-mkdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tiryoh","download_url":"https://codeload.github.com/Tiryoh/actions-mkdocs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tiryoh%2Factions-mkdocs/sbom","scorecard":{"id":142187,"data":{"date":"2025-08-11","repo":{"name":"github.com/Tiryoh/actions-mkdocs","commit":"14d3fd544b7a2bcffcdd86b05d558f20c244c9fc"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.7,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 1 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":"Code-Review","score":10,"reason":"all changesets reviewed","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: script injection with untrusted input ' github.event.issue.title ': .github/workflows/release-candidate.yaml:28"],"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/check-release-condition.yml:1","Warn: no topLevel permission defined: .github/workflows/release-candidate.yaml:1","Warn: no topLevel permission defined: .github/workflows/test.yaml:1","Warn: no topLevel permission defined: .github/workflows/version-tag.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":"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":"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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: 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":"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/check-release-condition.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiryoh/actions-mkdocs/check-release-condition.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-candidate.yaml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiryoh/actions-mkdocs/release-candidate.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-candidate.yaml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiryoh/actions-mkdocs/release-candidate.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiryoh/actions-mkdocs/test.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiryoh/actions-mkdocs/test.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/version-tag.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/Tiryoh/actions-mkdocs/version-tag.yml/main?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating tiryoh/mkdocs-builder:debian to tiryoh/mkdocs-builder:debian@sha256:949b676f91d2447c63c4aea0fb5d75cd4df76d04804bdacb5e01524370f1abe5","Warn: pipCommand not pinned by hash: entrypoint.sh:18","Info:   0 out of   5 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   1 pipCommand 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":"Branch-Protection","score":5,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'main'","Info: 'force pushes' disabled on branch 'main'","Warn: 'branch protection settings apply to administrators' is disabled on branch 'main'","Warn: 'stale review dismissal' is disabled on branch 'main'","Warn: required approving review count is 1 on branch 'main'","Warn: codeowners review is not required on branch 'main'","Warn: 'last push approval' is disabled on branch 'main'","Warn: no status checks found to merge onto branch 'main'","Info: PRs are required in order to make changes on branch 'main'"],"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":"Vulnerabilities","score":0,"reason":"14 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2024-230 / GHSA-248v-346w-9cwc","Warn: Project is vulnerable to: PYSEC-2024-60 / GHSA-jjg7-2v4v-x38h","Warn: Project is vulnerable to: GHSA-cpwx-vrp4-4pq7","Warn: Project is vulnerable to: GHSA-gmj6-6f8f-6699","Warn: Project is vulnerable to: GHSA-h5c8-rqwp-cp95","Warn: Project is vulnerable to: GHSA-h75v-3vvj-5mfj","Warn: Project is vulnerable to: GHSA-q2x7-8rv6-6q7h","Warn: Project is vulnerable to: GHSA-9hjg-9r4m-mvj7","Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56","Warn: Project is vulnerable to: PYSEC-2025-49 / GHSA-5rjg-fvgr-3xxf","Warn: Project is vulnerable to: GHSA-cx63-2mw6-8hw5","Warn: Project is vulnerable to: GHSA-34jh-p97f-mpxf","Warn: Project is vulnerable to: GHSA-pq67-6m6q-mj2v","Warn: Project is vulnerable to: GHSA-jfmj-5v4g-7637"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 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"}}]},"last_synced_at":"2025-08-16T08:23:47.243Z","repository_id":41865741,"created_at":"2025-08-16T08:23:47.243Z","updated_at":"2025-08-16T08:23:47.243Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000706,"owners_count":26082921,"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-10-09T02:00:07.460Z","response_time":59,"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":["actions","github-pages","mkdocs"],"created_at":"2025-06-26T03:03:41.076Z","updated_at":"2025-10-09T04:40:07.158Z","avatar_url":"https://github.com/Tiryoh.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# actions-mkdocs\n\n[![Test](https://github.com/Tiryoh/actions-mkdocs/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/Tiryoh/actions-mkdocs/actions/workflows/test.yaml?query=branch%3Amain)\n\nGitHub Actions for MkDocs\n\n## Inputs\n\n### `mkdocs_version`\n\nDefault: `'latest'`\n\nThe version of pip, MkDocs. \n\n### `requirements`\n\nDefault: `requirements.txt`\n\nThe path to `requirements.txt`\n\n### `configfile`\n\nDefault: `mkdocs.yml`\n\nThe path to `mkdocs.yml`\n\n## Example usage\n\n```yaml\nname: Deploy\non:\n  push:\n    branches:\n      - main\njobs:\n  build:\n    name: Deploy docs to GitHub Pages\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout \n        uses: actions/checkout@v2\n      - name: Build\n        uses: Tiryoh/actions-mkdocs@v0\n        with:\n          mkdocs_version: 'latest' # option\n          #mkdocs_version: '1.1' # option\n          requirements: 'requirements.txt' # option\n          configfile: 'mkdocs.yml' # option\n      - name: Deploy\n        uses: peaceiris/actions-gh-pages@v3\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n          publish_dir: ./site\n```\n\n## Related projects\n\n* [Tiryoh/docker-mkdocs-builder](https://github.com/Tiryoh/docker-mkdocs-builder)\n    * Dockerfile that just builds the MkDocs document\n* [squidfunk/mkdocs-material](https://github.com/squidfunk/mkdocs-material)\n    * A Material Design theme for MkDocs, this project includes build \u0026 deploy Dockerfile\n* [peaceiris/actions-gh-pages](https://github.com/peaceiris/actions-gh-pages)\n    * GitHub Actions for GitHub Pages rocket Deploy static files and publish your site easily. Static-Site-Generators-friendly.\n\n\n## License\n\nCopyright (c) 2020-2021 Daisuke Sato\n\nThis repository is licensed under the MIT License, see [LICENSE](./LICENSE).\nUnless attributed otherwise, everything in this repository is licensed under the MIT license.\n\n### Acknowledgements\n\nThis repository includes third-party libraries and software. See [THIRD-PARTY-NOTICES.md](./THIRD-PARTY-NOTICES.md).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiryoh%2Factions-mkdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftiryoh%2Factions-mkdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiryoh%2Factions-mkdocs/lists"}