{"id":20462001,"url":"https://github.com/denvercoder1/doxygen-github-pages-action","last_synced_at":"2025-10-04T19:02:28.859Z","repository":{"id":40579333,"uuid":"435346487","full_name":"DenverCoder1/doxygen-github-pages-action","owner":"DenverCoder1","description":"GitHub Action for deploying Doxygen documentation to a GitHub pages branch","archived":false,"fork":false,"pushed_at":"2024-09-26T18:42:35.000Z","size":24,"stargazers_count":97,"open_issues_count":2,"forks_count":18,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-09-28T11:29:53.990Z","etag":null,"topics":["actions","actionshackathon21","deployment-automation","doxygen","github-workflows","hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":null,"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/DenverCoder1.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":"2021-12-06T03:19:32.000Z","updated_at":"2025-09-13T05:58:11.000Z","dependencies_parsed_at":"2024-08-08T15:45:05.878Z","dependency_job_id":"f8e1798f-9a0d-4dd4-990b-cc2e1120c11d","html_url":"https://github.com/DenverCoder1/doxygen-github-pages-action","commit_stats":{"total_commits":15,"total_committers":2,"mean_commits":7.5,"dds":0.06666666666666665,"last_synced_commit":"a1ff6f448643817bf4c71be547b8ee3e3ca11d22"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/DenverCoder1/doxygen-github-pages-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DenverCoder1%2Fdoxygen-github-pages-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DenverCoder1%2Fdoxygen-github-pages-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DenverCoder1%2Fdoxygen-github-pages-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DenverCoder1%2Fdoxygen-github-pages-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DenverCoder1","download_url":"https://codeload.github.com/DenverCoder1/doxygen-github-pages-action/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DenverCoder1%2Fdoxygen-github-pages-action/sbom","scorecard":{"id":39365,"data":{"date":"2025-08-11","repo":{"name":"github.com/DenverCoder1/doxygen-github-pages-action","commit":"a5ce84b4f3636592e0c101064b66136851c1605b"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.2,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"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":"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":"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":-1,"reason":"No tokens found","details":null,"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":"Code-Review","score":1,"reason":"Found 4/21 approved changesets -- score normalized to 1","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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for 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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 26 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-14T21:06:49.880Z","repository_id":40579333,"created_at":"2025-08-14T21:06:49.880Z","updated_at":"2025-08-14T21:06:49.880Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278358487,"owners_count":25973949,"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-04T02:00:05.491Z","response_time":63,"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","actionshackathon21","deployment-automation","doxygen","github-workflows","hacktoberfest"],"created_at":"2024-11-15T12:29:27.585Z","updated_at":"2025-10-04T19:02:28.789Z","avatar_url":"https://github.com/DenverCoder1.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Doxygen GitHub Pages Deploy Action\n\nGitHub Action for making and deploying Doxygen documentation to a GitHub pages branch\n\n## Basic Usage\n\nTo deploy docs on every push to the `main` branch, create a new file in the `.github/workflows/` directory called `doxygen-gh-pages.yml` with the following contents:\n\n```yml\nname: Doxygen GitHub Pages Deploy Action\n\non:\n  push:\n    branches:\n      - main\n\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n    permissions:\n      contents: write\n    steps:\n      - uses: DenverCoder1/doxygen-github-pages-action@v2.0.0\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n```\n\n## Options\n\n- `github_token` (required): GitHub token for pushing to repo. See the [docs](https://git.io/passing-token) for more info.\n- `branch` (optional): Branch to deploy to. Defaults to `gh-pages`.\n- `folder` (optional): Folder where the docs are built. Defaults to `docs/html`.\n- `config_file` (optional): Path of the Doxygen configuration file. Defaults to `Doxyfile`.\n- `target_folder` (optional): Directory within the deployment branch to push to. Defaults to empty (root).\n- `doxygen_version` (optional): Version of Doxygen to install. Defaults to `1.9.6`. **NOTE - only works with 1.9.3 and higher versions**\n\n## Advanced Usage\n\nHere is an example of a `.github/workflows/doxygen-gh-pages.yml` file with more advanced configuration:\n\n```yml\nname: Doxygen GitHub Pages Deploy Action\n\non:\n  push:\n    branches:\n      - main\n  workflow_dispatch:\n\njobs:\n  deploy:\n    runs-on: ubuntu-latest\n    permissions:\n      contents: write\n    steps:\n      - uses: DenverCoder1/doxygen-github-pages-action@v2.0.0\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n          branch: gh-pages\n          folder: docs/html\n          config_file: Doxyfile\n          doxygen_version: 1.9.6\n```\n\n## About this Action\n\nThis action is a composite action containing the following steps:\n\n### 1. Checkout repository\n\nThe [actions/checkout](https://github.com/actions/checkout) step is used to checkout the repository with any submodules.\n\n### 2. Install Doxygen\n\nDoxygen and Graphviz are installed by running the following command:\n\n```bash\nsudo apt-get install doxygen graphviz -y\n```\n\n### 3. Generate Doxygen Documentation\n\nDoxygen documentation is generated by running the following command.\n\nSet the `config_file` input option to change `Doxyfile` to a different filename.\n\n```bash\ndoxygen Doxyfile\n```\n\n### 4. Create .nojekyll\n\nCreating a .nojekyll file ensures pages with underscores work on GitHub Pages.\n\nSet the `folder` input option to change `docs/html` to a different folder.\n\n```bash\ntouch docs/html/.nojekyll\n```\n\n### 5. Deploy to GitHub Pages\n\nThe [JamesIves/github-pages-deploy-action](https://github.com/JamesIves/github-pages-deploy-action) action is used to deploy the documentation to GitHub Pages.\n\nThe `folder` option determines which folder to deploy. By default, it is `docs/html`.\n\nThe `branch` option determines which branch to deploy to. By default, it is `gh-pages`.\n\nThe `target_folder` option determines which directory in the deployment branch to push to. By default, the root of the branch is overwritten.\n\n## License\n\nThis work is under an [MIT license](LICENSE)\n\n## Support\n\nIf you like this project, give it a ⭐ and share it with friends!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdenvercoder1%2Fdoxygen-github-pages-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdenvercoder1%2Fdoxygen-github-pages-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdenvercoder1%2Fdoxygen-github-pages-action/lists"}