Skip to content
This repository was archived by the owner on Jul 2, 2023. It is now read-only.

Upgrade: Bump Andrew-Chen-Wang/github-wiki-action from 3 to 4 - #187

Merged
github-actions[bot] merged 1 commit into
masterfrom
dependabot/github_actions/Andrew-Chen-Wang/github-wiki-action-4
May 22, 2023
Merged

Upgrade: Bump Andrew-Chen-Wang/github-wiki-action from 3 to 4#187
github-actions[bot] merged 1 commit into
masterfrom
dependabot/github_actions/Andrew-Chen-Wang/github-wiki-action-4

Conversation

@dependabot

@dependabot dependabot Bot commented on behalf of github May 22, 2023

Copy link
Copy Markdown
Contributor

Bumps Andrew-Chen-Wang/github-wiki-action from 3 to 4.

Release notes

Sourced from Andrew-Chen-Wang/github-wiki-action's releases.

v4.0.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

... (truncated)

Commits
  • ea8349a Merge pull request #51 from Andrew-Chen-Wang/jcbhmr-patch-1
  • 001b31e Add quicklinks to top
  • 2d06d56 Merge pull request #48 from Andrew-Chen-Wang/jcbhmr-patch-1
  • a70a020 Add GitHub token dev notes
  • b667cf6 Merge pull request #45 from Andrew-Chen-Wang/add-strategy-switch
  • bc99ea6 Merge remote-tracking branch 'origin/master' into add-strategy-switch
  • 20928f7 add clone & init tests
  • 8303bf9 chmod +x
  • 913a280 Merge branch 'master' into add-strategy-switch
  • 3adfd65 Merge pull request #43 from Andrew-Chen-Wang/add-github-server-url
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [Andrew-Chen-Wang/github-wiki-action](https://github.com/Andrew-Chen-Wang/github-wiki-action) from 3 to 4.
- [Release notes](https://github.com/Andrew-Chen-Wang/github-wiki-action/releases)
- [Commits](Andrew-Chen-Wang/github-wiki-action@v3...v4)

---
updated-dependencies:
- dependency-name: Andrew-Chen-Wang/github-wiki-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot Bot added the dependencies Pull requests that update a dependency file label May 22, 2023
@github-actions
github-actions Bot merged commit 07cf93d into master May 22, 2023
@dependabot
dependabot Bot deleted the dependabot/github_actions/Andrew-Chen-Wang/github-wiki-action-4 branch May 22, 2023 11:58
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

dependencies Pull requests that update a dependency file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants