github-wiki-action

Sike! 🤯 Actually that feature where we rewrite links is going in v5 since it's a breaking change. Hopefully I didn't break your workflow! 😜

What's Changed

• Revert "Add in-source to in-wiki link transformer" by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/72

Full Changelog: https://github.com/Andrew-Chen-Wang/github-wiki-action/compare/v4...v4.4.0

The big highlight is that now README.md in the wiki folder in your GitHub repo will be deployed to Home.md on the GitHub wiki! This means you can use the same conventions like README.md as an "index page" for GitHub web-ui and expect that to work flawlessly on the github wiki too. Also included are link rewrites to make it so that [](hello.md) links that work in GitHub web-ui become [](hello) links that work for the GitHub wiki UI!

What's Changed

• Create .gitattributes by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/64
• "Real" tests on PRs by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/69
• Better "real" tests by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/70
• Revert extreme use of "real" tests in favor of dry-run & real tests by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/71
• Add in-source to in-wiki link transformer by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/68

Full Changelog: https://github.com/Andrew-Chen-Wang/github-wiki-action/compare/v4...v4.3.0

🎉 New feature! We added a wiki_url output similar to the https://github.com/actions/deploy-pages page_url output. Yes, it's snake_case instead of kebab-case. That's to conform with the existing convention from actions/deploy-pages. 🤷‍♂️

What's Changed

• Add shellcheck by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/60
• Improve test.yml by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/62
• Move comments from source code to wiki by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/61
• Add wiki_url output by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/63

Full Changelog: https://github.com/Andrew-Chen-Wang/github-wiki-action/compare/v4...v4.2.0

Fixed silly if [[ -z $RUNNER_DEBUG ]] to be if [[ -n $RUNNER_DEBUG ]] so now you'll only get verbose debug logging if you actually enable debug mode, not only in non-debug mode! This is an oopsie bugfix. #58

What's Changed

• if non-zero $RUNNER_DEBUG by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/59

Full Changelog: https://github.com/Andrew-Chen-Wang/github-wiki-action/compare/v4...v4.1.1

What's Changed

• Clarify GitHub token behaviour by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/53
• Add more informative logs by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/54

Full Changelog: https://github.com/Andrew-Chen-Wang/github-wiki-action/compare/v4...v4.1.0

This is a pretty massive release! @jcbhmr made a lot of changes to modernize this action and bring it more in-line with other actions. For instance, now we use with: instead of env: to pass inputs to the script. We also have dropped rsync! We now use a trick with $GIT_DIR and $GIT_WORK_TREE to commit your files without ever copying or moving them! Isn't that cool! 😎 Since we dropped rsync, we no longer need to use Docker! #32 That means you can now use this action on Windows if you're using v4. 👍

We've also made it so that the ${{ github.token }} will be picked up by default just like all your favorite official github.com/actions Actions!

Migration guide

If you're still using v3, here's a quick guide to transition to using v4. We hope you like the new interface!

1. Find all your workflows that use v3. This can be done via a per-user or per-org code search.
2. Replace the v3 tag with v4. We'll only introduce breaking changes in major versions. We use semver.
3. If you're using GH_TOKEN: ${{ github.token }} or GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}, you can remove it. We now use that token by default if none is provided. If you need to provide a custom PAT, use with: and then token: ${{ secrets.PAT }}.
4. To define the path, we now use the standard with: path: option. You no longer need a trailing slash like you did when we used rsync. 😁
5. Our new default commit message is Update wiki ${{ github.sha }}. If you want to change this, you can use commit-message: Hi!.
6. If you're setting the commit author, you don't need to do that anymore. We use the @github-actions user to take ownership of the stuff that gets committed. If you really want to change that, you could use the $GIT_AUTHOR_NAME and other GIT_* env vars.
7. We now use standard .gitignore syntax for our ignore: input. This used to be a space-separated EXCLUDED_FILES list. Make sure you separate your ignore list by newlines! You can use the | pipe to get a multiline string in YAML.
8. Commit & make a PR for your changes! 🎉

Here's an example of the transition:

- uses: Andrew-Chen-Wang/github-wiki-action@v2
  env:
    WIKI_DIR: my-wiki/
    GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
    GH_MAIL: ${{ secrets.YOUR_EMAIL }}
    GH_NAME: ${{ github.repository_owner }}
    EXCLUDED_FILES: "Special-page.md Hidden.md"

- uses: Andrew-Chen-Wang/github-wiki-action@v4
  with:
    path: my-wiki
    ignore: |
      Special-page.md
      Hidden.md

🆘 If you have any questions, you can open an Issue or open a Discussion! We'd be happy to help you!

What's Changed

• Upgrade readme by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/22
• Use raw bash by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/40
• Add tests by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/41
• Add update-tags.yml workflow by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/42
• Add note about links on GitHub source view vs GitHub wiki by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/44
• Add image to readme by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/47
• Add github-server-url option by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/43
• Add strategy switch by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/45
• Add GitHub token dev notes by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/48
• Add quicklinks to top by @jcbhmr in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/51

New Contributors

• @jcbhmr made their first contribution in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/22

Full Changelog: https://github.com/Andrew-Chen-Wang/github-wiki-action/compare/v3...v4.0.0

Please update immediately for this action to work properly

What's Changed

• Disable git safe repo check and optimize behavior by @rcdailey in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/10

New Contributors

• @rcdailey made their first contribution in https://github.com/Andrew-Chen-Wang/github-wiki-action/pull/10

Full Changelog: https://github.com/Andrew-Chen-Wang/github-wiki-action/compare/v2...v3

• Allow for secrets.GITHUB_TOKEN instead of PAT - Allow for exclusion of files

Allows GITHUB_TOKEN if REPO is allowed to be the current one. If the wiki repo is different form the current, you must specify a PAT.