{"id":13994768,"url":"https://github.com/SwiftDocOrg/github-wiki-publish-action","last_synced_at":"2025-07-22T20:30:59.926Z","repository":{"id":52790294,"uuid":"234969336","full_name":"SwiftDocOrg/github-wiki-publish-action","owner":"SwiftDocOrg","description":"GitHub Action that publishes the contents of a directory to your project's wiki","archived":true,"fork":false,"pushed_at":"2021-04-19T12:22:09.000Z","size":18,"stargazers_count":83,"open_issues_count":1,"forks_count":35,"subscribers_count":1,"default_branch":"v1","last_synced_at":"2025-06-30T21:07:45.605Z","etag":null,"topics":["github-actions","github-wiki"],"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/SwiftDocOrg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-19T21:16:42.000Z","updated_at":"2025-06-21T08:51:24.000Z","dependencies_parsed_at":"2023-01-05T13:16:24.296Z","dependency_job_id":null,"html_url":"https://github.com/SwiftDocOrg/github-wiki-publish-action","commit_stats":{"total_commits":7,"total_committers":2,"mean_commits":3.5,"dds":0.1428571428571429,"last_synced_commit":"d705b3354a51ceb6259cb11c54129c61cff71cd4"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/SwiftDocOrg/github-wiki-publish-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SwiftDocOrg%2Fgithub-wiki-publish-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SwiftDocOrg%2Fgithub-wiki-publish-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SwiftDocOrg%2Fgithub-wiki-publish-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SwiftDocOrg%2Fgithub-wiki-publish-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SwiftDocOrg","download_url":"https://codeload.github.com/SwiftDocOrg/github-wiki-publish-action/tar.gz/refs/heads/v1","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SwiftDocOrg%2Fgithub-wiki-publish-action/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266567173,"owners_count":23949298,"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-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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","github-wiki"],"created_at":"2024-08-09T14:03:05.776Z","updated_at":"2025-07-22T20:30:59.662Z","avatar_url":"https://github.com/SwiftDocOrg.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# Github Wiki Publish Action\n\nThis [GitHub Action][github actions]\npublishes the contents of a directory to your project's [wiki][github wiki]\nfrom a workflow.\n\n## Usage\n\nIn a new or existing workflow,\nadd a step using `SwiftDocOrg/github-wiki-publish-action@v1`\nwith a path to a directory containing the documentation you wish to upload.\n\n```yml\nname: Documentation\n\non: [push]\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n\n    steps:\n      - uses: actions/checkout@v1\n      # Additional steps to generate documentation in \"Documentation\" directory\n      - name: Upload Documentation to Wiki\n        uses: SwiftDocOrg/github-wiki-publish-action@v1\n        with:\n          path: \"Documentation\"\n        env:\n          GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}\n```\n\n### Supported Products\n\n- [x] GitHub.com\n- [x] GitHub Enterprise Cloud\n- [x] GitHub Enterprise Server \n- [x] GitHub AE\n\n## Setup\n\nThis GitHub action requires that your repository has the following:\n\n- A wiki with at least one page in it\n- A secret named `GH_PERSONAL_ACCESS_TOKEN`\n  with a Github personal access token with \"repo\" authorization\n\nFollow the steps below to ensure that everything's configured correctly.\n\n\u003e **Note**\n\u003e GitHub doesn't currently provide APIs for interacting with project wikis,\n\u003e so much of the required setup must be done manually.\n\n### 1. Enable Your Repository's Wikis Feature\n\nNavigate to the \"Settings\" tab for your repository,\nscroll down to the \"Features\" section,\nand ensure that the checkbox labeled \"Wikis\" is checked.\n\n![GitHub Wikis Feature](https://user-images.githubusercontent.com/7659/72726104-5f3aff80-3b3c-11ea-8f2e-fe73aff0276b.png)\n\n### 2. Create the First Wiki Page\n\nWith the Wikis feature enabled for your repository,\nnavigate to the \"Wiki\" tab.\nIf prompted,\ncreate the first wiki page.\n\n![GitHub Wiki Create First Page](https://user-images.githubusercontent.com/7659/72726186-927d8e80-3b3c-11ea-8014-4622f8ff3226.png)\n\n### 3. Generate a Personal Access Token\n\nNavigate to the [Personal access tokens](https://github.com/settings/tokens) page\nin your GitHub account settings\n(Settings \u003e Developer settings \u003e Personal access tokens)\nand click the \"Generate a new token\" button.\n\nIn the \"New personal access token\" form,\nprovide a descriptive comment in the \"Note\" field, like \"Wiki Management\".\nUnder \"Select scopes\",\nenable all of the entries under \"repo\" perms.\n\nWhen you're done,\nclick the \"Generate token\" button at the bottom of the form.\n\n![GitHub Personal Access Token Select Scopes](https://user-images.githubusercontent.com/7659/72726210-9f9a7d80-3b3c-11ea-81b4-528de92fb9fa.png)\n\n\u003e **Note**:\n\u003e GitHub actions have access to [a `GITHUB_TOKEN` secret][GITHUB_TOKEN],\n\u003e but that token's permissions are limited to\n\u003e the repository that contains your workflow.\n\u003e This workflow requires the generation of a new personal access token\n\u003e to read and write to the git repository for your project's wiki.\n\n### 4. Set a Repository Secret\n\nCopy your generated personal access token to the clipboard\nand navigate to your project settings.\nNavigate to the \"Secrets\" page,\nclick \"Add a new secret\",\nand fill in the form by\nentering `GH_PERSONAL_ACCESS_TOKEN` into the \"Name\" field and\npasting your token into the \"Value\" field.\n\n## License\n\nMIT\n\n## Contact\n\nMattt ([@mattt](https://twitter.com/mattt))\n\n[github actions]: https://help.github.com/en/actions\n[github wiki]: https://help.github.com/en/github/building-a-strong-community/about-wikis\n[GITHUB_TOKEN]: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token#about-the-github_token-secret\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSwiftDocOrg%2Fgithub-wiki-publish-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSwiftDocOrg%2Fgithub-wiki-publish-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSwiftDocOrg%2Fgithub-wiki-publish-action/lists"}