search

ansible-community / github-docs-build

GitHub actions and workflows for building Ansible collection documentation.
GNU General Public License v3.0
10 stars 6 forks source link

Bump Andrew-Chen-Wang/github-wiki-action from 3 to 4 #79

Open dependabot[bot] opened 7 months ago

dependabot[bot] commented 7 months ago

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
  • 50650fc Merge pull request #72 from Andrew-Chen-Wang/revert-68-in-source-to-in-wiki-l...
  • 06e1bc0 Revert "Add in-source to in-wiki link transformer"
  • 6d341e2 format
  • 6581fc5 Merge pull request #68 from Andrew-Chen-Wang/in-source-to-in-wiki-links
  • e17592a Update .gitattributes
  • 10944fa Update test-action.yml
  • df95057 Create .gitattributes
  • 4b81a9b add preprocess note
  • a0f0d67 add dev section
  • 0e953c5 use more appropriate core methods
  • Additional commits viewable in compare view


Dependabot compatibility score

You can trigger a rebase of this PR 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 show ignore conditions` will show all of the ignore conditions of the specified dependency - `@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)

Note Automatic rebases have been disabled on this pull request as it has been open for over 30 days.

felixfontein commented 7 months ago

According to https://github.com/Andrew-Chen-Wang/github-wiki-action/releases/tag/v4.0.0:

Line 58: can be removed, and instead with: path: ${{ env.WIKI }} added Line 59: GH_TOKEN can be removed Lines 60 and 64: can also be changed apparently