{"id":22125094,"url":"https://github.com/kiarashvosough1999/docc-github-pages-deploy","last_synced_at":"2025-10-09T15:45:35.119Z","repository":{"id":65160475,"uuid":"539860255","full_name":"kiarashvosough1999/docC-github-pages-deploy","owner":"kiarashvosough1999","description":"Deploy Generated DocC Static Site To Github-Pages.","archived":false,"fork":false,"pushed_at":"2022-09-22T11:42:48.000Z","size":17,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-01T13:02:09.010Z","etag":null,"topics":["docc","documentation","github-pages","githubpages","ios","macos","spm","static-site","swift"],"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/kiarashvosough1999.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}},"created_at":"2022-09-22T07:46:18.000Z","updated_at":"2024-04-30T06:23:43.000Z","dependencies_parsed_at":"2023-01-13T15:43:56.438Z","dependency_job_id":null,"html_url":"https://github.com/kiarashvosough1999/docC-github-pages-deploy","commit_stats":{"total_commits":9,"total_committers":2,"mean_commits":4.5,"dds":0.2222222222222222,"last_synced_commit":"393414cb475273b8ac2108c644d9854c2d717a2f"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiarashvosough1999%2FdocC-github-pages-deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiarashvosough1999%2FdocC-github-pages-deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiarashvosough1999%2FdocC-github-pages-deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiarashvosough1999%2FdocC-github-pages-deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kiarashvosough1999","download_url":"https://codeload.github.com/kiarashvosough1999/docC-github-pages-deploy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227590204,"owners_count":17790447,"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":["docc","documentation","github-pages","githubpages","ios","macos","spm","static-site","swift"],"created_at":"2024-12-01T16:17:02.435Z","updated_at":"2025-10-09T15:45:35.011Z","avatar_url":"https://github.com/kiarashvosough1999.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Twitter](https://img.shields.io/badge/Twitter-@Vosough_k-blue.svg?style=flat-square)](https://twitter.com/vosough_k)\r\n[![Linkedin](https://img.shields.io/badge/Linkedin-KiarashVosough-blue.svg?style=flat-square)](https://www.linkedin.com/in/kiarashvosough/)\r\n\r\nDocC Github Pages Deploy: Deploy Generated DocC Static Site To Github-Pages.\r\n\r\n- [Requirements](#requirements)\r\n- [Usage](#usage)\r\n- [Integration](#integration-with-build-docC-static-site)\r\n- [Contributors](#contributors)\r\n- [License](#license)\r\n\r\n## Requirements\r\n\r\n| Platform  | Status |\r\n| --- | --- |\r\n|  ubuntu-latest | Tested |\r\n\r\n## Usage\r\n\r\nSee [action.yml](https://github.com/kiarashvosough1999/docC-github-pages-deploy/blob/master/action.yml).\r\n\r\n\u003e Make sure to set the version to latest tag.\r\n\r\nAs An Example:\r\n\r\n```yml\r\nname: worksapce\r\non:\r\n  push:\r\n    branches:\r\n      - '**'\r\njobs:\r\n  build_deploy_site:\r\n    runs-on: ubuntu-latest\r\n    environment:\r\n      name: github-pages\r\n      url: ${{ steps.deployment.outputs.page_url }}\r\n\r\n    permissions:\r\n      pages: write\r\n      contents: read\r\n      id-token: write\r\n\r\n    steps:\r\n    - name: deploy static site\r\n      uses: kiarashvosough1999/docC-github-pages-deploy@v1.0.0\r\n```\r\n\r\n\u003e Make Sure give access to `pages`, `contents` and `id-token`, or the action will fail to push the site into Github-Pages.\r\n\r\n\u003e Make sure to specify the `name` and `url` on the environment like the example, or the job will fail.\r\n\r\n\r\n## Integration With Build DocC Static Site\r\n\r\nYou can use [build-docC-static-site](https://github.com/kiarashvosough1999/build-docC-static-site/tree/master) to generate static site from DocC Archive.\r\n\r\n\u003e The default `docC-generated-static-site-uploaded-name` associated with [build-docC-static-site\r\n](https://github.com/kiarashvosough1999/build-docC-static-site/tree/master) and `docC-generated-static-site-zipped-upload-name` associated with this action, input must be the same.\r\n\r\n\u003e This action will unzip the input static site with `gtar` and `tar` extension. So do not specify the zip extension on either `docC-generated-static-site-uploaded-name` or `docC-generated-static-site-zipped-upload-name`.\r\n \r\n## Contributors\r\n\r\nFeel free to share your ideas or any other problems. Pull requests are welcomed.\r\n\r\n## License\r\n\r\ndocC-github-pages-deploy is released under an MIT license. See [LICENSE](https://github.com/kiarashvosough1999/build-docC-static-site/blob/master/LICENSE) for more information.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkiarashvosough1999%2Fdocc-github-pages-deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkiarashvosough1999%2Fdocc-github-pages-deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkiarashvosough1999%2Fdocc-github-pages-deploy/lists"}