{"id":16694690,"url":"https://github.com/spenserblack/actions-wiki","last_synced_at":"2025-04-10T01:33:18.119Z","repository":{"id":98834313,"uuid":"587427075","full_name":"spenserblack/actions-wiki","owner":"spenserblack","description":":open_book: Deploy docs from your source tree to a GitHub wiki","archived":false,"fork":false,"pushed_at":"2023-06-14T14:03:04.000Z","size":107,"stargazers_count":11,"open_issues_count":8,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-04T04:01:37.919Z","etag":null,"topics":["action","actions","github","github-actions","github-wiki","wiki"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/wiki-update","language":"TypeScript","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/spenserblack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2023-01-10T18:18:11.000Z","updated_at":"2025-03-31T08:41:30.000Z","dependencies_parsed_at":"2024-10-25T09:13:46.462Z","dependency_job_id":null,"html_url":"https://github.com/spenserblack/actions-wiki","commit_stats":{"total_commits":51,"total_committers":4,"mean_commits":12.75,"dds":0.5098039215686274,"last_synced_commit":"60b6d133a11f8443c48e5b7af1aff0cd9461abf8"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spenserblack%2Factions-wiki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spenserblack%2Factions-wiki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spenserblack%2Factions-wiki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spenserblack%2Factions-wiki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spenserblack","download_url":"https://codeload.github.com/spenserblack/actions-wiki/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248140784,"owners_count":21054353,"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":["action","actions","github","github-actions","github-wiki","wiki"],"created_at":"2024-10-12T16:47:39.655Z","updated_at":"2025-04-10T01:33:18.093Z","avatar_url":"https://github.com/spenserblack.png","language":"TypeScript","readme":"# Publish to GitHub wiki action\n\n[![CI](https://github.com/spenserblack/actions-wiki/actions/workflows/ci.yml/badge.svg)](https://github.com/spenserblack/actions-wiki/actions/workflows/ci.yml)\n[![Dogfood Test](https://github.com/spenserblack/actions-wiki/actions/workflows/dogfood.yml/badge.svg)](https://github.com/spenserblack/actions-wiki/actions/workflows/dogfood.yml)\n[![Check dist/](https://github.com/spenserblack/actions-wiki/actions/workflows/check-dist.yml/badge.svg)](https://github.com/spenserblack/actions-wiki/actions/workflows/check-dist.yml)\n[![codecov](https://codecov.io/gh/spenserblack/actions-wiki/branch/main/graph/badge.svg?token=UhUknoRBkx)](https://codecov.io/gh/spenserblack/actions-wiki)\n\n📖 Deploy docs from your source tree to the GitHub wiki\n\n\u003cdiv align=\"center\"\u003e\n\n![](https://user-images.githubusercontent.com/61068799/231881220-2915f956-dbdb-4eee-8807-4eba9537523f.png)\n\n\u003c/div\u003e\n\n🌐 Works across repositories (with a [PAT][pat]) \\\n📚 Pretty interface for Markdown docs \\\n⤴️ Lets you open PRs for wiki docs \\\n💻 Supports `runs-on: windows-*`\n\n## Usage\n\n![GitHub Actions](https://img.shields.io/static/v1?style=for-the-badge\u0026message=GitHub+Actions\u0026color=2088FF\u0026logo=GitHub+Actions\u0026logoColor=FFFFFF\u0026label=)\n![GitHub wiki](https://img.shields.io/static/v1?style=for-the-badge\u0026message=GitHub+wiki\u0026color=181717\u0026logo=GitHub\u0026logoColor=FFFFFF\u0026label=)\n\nGetting started is easy! Just create a GitHub Actions workflow file that uses\nspenserblack/actions-wiki and you're good to go! 🚀 Here's a ready-made example\nto help you blast off:\n\n```yml\nname: Publish wiki\non:\n  push:\n    branches: [main]\n    paths: [wiki/**, .github/workflows/publish-wiki.yml]\nconcurrency:\n  group: wiki\n  cancel-in-progress: true\npermissions:\n  contents: write\njobs:\n  wiki:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v3\n      - uses: spenserblack/actions-wiki@\u003cversion\u003e\n        with:\n          # Whatever directory you choose will be mirrored to the GitHub\n          # .wiki.git. The default is .github/wiki.\n          path: wiki\n```\n\n\u003cimg align=\"right\" alt=\"Screenshot of 'Create the first page' button\" src=\"https://i.imgur.com/ABKIS4h.png\" /\u003e\n\n❗ Make sure you turn on the GitHub wiki feature in your repo's settings menu.\nYou'll also need to _manually_ create a dummy page to initialize the git repo\nthat powers the GitHub wiki. If you don't, when we push to `your-repo.wiki.git`,\nyour workflow will fail because the wiki doesn't exist.\n\n⚠️ You'll need to remember to enable the `contents: write` permission! GitHub\nrecently [changed the default permissions granted to jobs][default-permissions-update] for new repositories.\n\n### Publishing to a different repository\n\nIf you're pushing to a wiki that's **not the current repository** you'll need to\nget a [GitHub PAT][pat] to push to it. The default `${{ secrets.GITHUB_TOKEN }}`\nwon't cut it! You can [generate a PAT][generate-a-pat] in your GitHub Settings.\n\nFor example, if you created octocat/gigantic-mega-project-wiki to hold the wiki\nand you want to publish it to the GitHub wiki that belongs to _another\nrepository_ like octocat/gigantic-mega-project, you'd use a step like this in\none of your GitHub Actions workflows.\n\n```yml\n- uses: spenserblack/actions-wiki@\u003cversion\u003e\n  with:\n    path: .\n    # Notice that we use a github.com/ prefix here to support enterprise GitHub\n    # deployments on other domains.\n    repository: github.com/octocat/gigantic-mega-project\n    # Make sure this token has the appropriate push permissions!\n    token: ${{ secrets.GIGANTIC_MEGA_PROJECT_GITHUB_TOKEN }}\n```\n\n### Options\n\n- **`repository`:** The repository housing the wiki. Use this if you're\n  publishing to a wiki that's not the current repository. You _can include a\n  domain prefix_ if you have a hosted GitHub instance that you want to push to.\n  Default is `${{ github.repository }}` with the implicit `github.com` domain.\n\n- **`token`:** `${{ github.token }}` is the default. This token is used when\n  cloning and pushing wiki changes.\n\n- **`path`:** The directory to use for your wiki contents. Default:\n  `.github/wiki`.\n\n- **`commit-message`:** The message to use when committing new content. Default\n  is `Update wiki ${{ github.sha }}`. You probably don't need to change this,\n  since this only applies if you look _really closely_ in your wiki.\n\n- **`dry-run`:** Whether or not to actually attempt to push changes back to the\n  wiki itself. If this is set to `true`, we instead print the remote URL and do\n  not push to the remote wiki. The default is `false`. This is useful for\n  testing.\n\n## Alternatives\n\nThere are quite a few GitHub wiki publishing actions on the [GitHub Actions marketplace][actions-marketplace]. There are, however, two that stick out. The\n[newrelic/wiki-sync-action][newrelic-action] is a good choice for if you need bidirectional\nsynchronization when someone edits the live wiki. This can be beneficial for\nless-technical contributors. There's also [Andrew-Chen-Wang/github-wiki-action][andrew-chen-wang-action]\nwhich is a direct competitor to this project. It offers more automatic features,\nbut has more complex configuration. It also [doesn't support `runs-on: windows-*`](https://github.com/Andrew-Chen-Wang/github-wiki-action/discussions/28).\n\n📚 If you're interested in more discussion of alternatives, check out [#4][issue-4].\n\n## Development\n\n![YAML](https://img.shields.io/static/v1?style=for-the-badge\u0026message=YAML\u0026color=CB171E\u0026logo=YAML\u0026logoColor=FFFFFF\u0026label=)\n![Bash](https://img.shields.io/static/v1?style=for-the-badge\u0026message=Bash\u0026color=4EAA25\u0026logo=GNU+Bash\u0026logoColor=FFFFFF\u0026label=)\n\nThis is a GitHub Action, so we inevitably use [YAML][yaml-notes]. Make sure you quote the\nright things! To test 🧪 the action, the current workflow is to open a PR and\nthen have the [`test.yml`](https://github.com/spenserblack/actions-wiki/blob/main/.github/workflows/test.yml) workflow run a `dry-run: true` iteration to\n(hopefully) spot any flaws.\n\nTo get a better handle on the contribution process, check out our handy\n[contributing guide][contributing]. Happy coding! 👋\n\n[newrelic-action]: https://github.com/newrelic/wiki-sync-action#readme\n[andrew-chen-wang-action]: https://github.com/Andrew-Chen-Wang/github-wiki-action#readme\n[issue-4]: https://github.com/spenserblack/actions-wiki/issues/4\n[pat]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token\n[default-permissions-update]: https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/\n[actions-marketplace]: https://github.com/marketplace?type=actions\n[generate-a-pat]: https://github.com/settings/tokens?type=beta\n[contributing]: https://github.com/spenserblack/actions-wiki/blob/main/CONTRIBUTING.md\n[yaml-notes]: https://earthly.dev/blog/intercal-yaml-and-other-horrible-programming-languages/\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspenserblack%2Factions-wiki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspenserblack%2Factions-wiki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspenserblack%2Factions-wiki/lists"}