From e611017ec63bbbefd835c4a7894e89e92df868cc Mon Sep 17 00:00:00 2001 From: Peter Evans <18365890+peter-evans@users.noreply.github.com> Date: Tue, 22 Mar 2022 16:03:48 +0900 Subject: [PATCH] docs: update readme and docs --- README.md | 2 +- docs/advanced-configuration.md | 8 ++++---- docs/examples.md | 28 ++++++++++++++-------------- docs/getting-started.md | 4 ++-- docs/updating.md | 12 ++++++++++++ docs/workflow-dispatch.md | 8 ++++---- 6 files changed, 37 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index ddcb7b9..ea8df04 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ See it in action with the following live demos. - [Standard configuration](#standard-configuration) - [Advanced configuration](docs/advanced-configuration.md) - [Workflow dispatch](docs/workflow-dispatch.md) -- [Updating to v2](docs/updating.md) +- [Updating to v3](docs/updating.md) ## Dispatching commands diff --git a/docs/advanced-configuration.md b/docs/advanced-configuration.md index b4b98d7..b864b1b 100644 --- a/docs/advanced-configuration.md +++ b/docs/advanced-configuration.md @@ -8,7 +8,7 @@ For example, the following basic configuration means that all commands must have ```yml - name: Slash Command Dispatch - uses: peter-evans/slash-command-dispatch@v2 + uses: peter-evans/slash-command-dispatch@v3 with: token: ${{ secrets.PAT }} commands: | @@ -38,7 +38,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Slash Command Dispatch - uses: peter-evans/slash-command-dispatch@v2 + uses: peter-evans/slash-command-dispatch@v3 with: token: ${{ secrets.PAT }} config: > @@ -82,9 +82,9 @@ jobs: slashCommandDispatch: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Slash Command Dispatch - uses: peter-evans/slash-command-dispatch@v2 + uses: peter-evans/slash-command-dispatch@v3 with: token: ${{ secrets.PAT }} config-from-file: .github/slash-command-dispatch.json diff --git a/docs/examples.md b/docs/examples.md index 5b32284..7e399d6 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -35,7 +35,7 @@ jobs: echo ::set-output name=branch::$branch # Checkout the branch to test - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 with: token: ${{ secrets.PAT }} repository: ${{ github.event.client_payload.github.payload.repository.full_name }} @@ -50,7 +50,7 @@ jobs: # Add reaction to the comment - name: Add reaction - uses: peter-evans/create-or-update-comment@v1 + uses: peter-evans/create-or-update-comment@v2 with: token: ${{ secrets.PAT }} repository: ${{ github.event.client_payload.github.payload.repository.full_name }} @@ -86,14 +86,14 @@ jobs: echo ::set-output name=branch::$branch # Checkout the branch to test - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 with: token: ${{ secrets.PAT }} repository: ${{ github.event.client_payload.github.payload.repository.full_name }} ref: ${{ steps.vars.outputs.branch }} # Setup Python environment - - uses: actions/setup-python@v1 + - uses: actions/setup-python@v3 # Install pytest - name: Install pytest @@ -111,7 +111,7 @@ jobs: # Add reaction to the comment - name: Add reaction - uses: peter-evans/create-or-update-comment@v1 + uses: peter-evans/create-or-update-comment@v2 with: token: ${{ secrets.PAT }} repository: ${{ github.event.client_payload.github.payload.repository.full_name }} @@ -141,7 +141,7 @@ jobs: runs-on: ubuntu-latest steps: # Checkout the pull request branch - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 with: token: ${{ secrets.PAT }} repository: ${{ github.event.client_payload.pull_request.head.repo.full_name }} @@ -158,7 +158,7 @@ jobs: git push - name: Add reaction - uses: peter-evans/create-or-update-comment@v1 + uses: peter-evans/create-or-update-comment@v2 with: token: ${{ secrets.PAT }} repository: ${{ github.event.client_payload.github.payload.repository.full_name }} @@ -187,7 +187,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout pull request - uses: actions/checkout@v2 + uses: actions/checkout@v3 with: token: ${{ secrets.PAT }} repository: ${{ github.event.client_payload.pull_request.head.repo.full_name }} @@ -204,7 +204,7 @@ jobs: git push --force-with-lease - name: Update comment - uses: peter-evans/create-or-update-comment@v1 + uses: peter-evans/create-or-update-comment@v2 with: token: ${{ secrets.PAT }} repository: ${{ github.event.client_payload.github.payload.repository.full_name }} @@ -218,7 +218,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Update comment - uses: peter-evans/create-or-update-comment@v1 + uses: peter-evans/create-or-update-comment@v2 with: token: ${{ secrets.PAT }} repository: ${{ github.event.client_payload.github.payload.repository.full_name }} @@ -248,14 +248,14 @@ jobs: runs-on: ubuntu-latest steps: # Checkout the pull request branch - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 with: token: ${{ secrets.PAT }} repository: ${{ github.event.client_payload.pull_request.head.repo.full_name }} ref: ${{ github.event.client_payload.pull_request.head.ref }} # Setup Python environment - - uses: actions/setup-python@v1 + - uses: actions/setup-python@v3 # Install black - name: Install black @@ -277,7 +277,7 @@ jobs: git push - name: Add reaction - uses: peter-evans/create-or-update-comment@v1 + uses: peter-evans/create-or-update-comment@v2 with: token: ${{ secrets.PAT }} repository: ${{ github.event.client_payload.github.payload.repository.full_name }} @@ -299,7 +299,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Update comment - uses: peter-evans/create-or-update-comment@v1 + uses: peter-evans/create-or-update-comment@v2 with: token: ${{ secrets.ACTIONS_BOT_TOKEN }} repository: ${{ github.event.client_payload.github.payload.repository.full_name }} diff --git a/docs/getting-started.md b/docs/getting-started.md index 509f3ce..503c79c 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -19,7 +19,7 @@ Follow this guide to get started with a working `/example` command. runs-on: ubuntu-latest steps: - name: Add reaction - uses: peter-evans/create-or-update-comment@v1 + uses: peter-evans/create-or-update-comment@v2 with: token: ${{ secrets.PAT }} repository: ${{ github.event.client_payload.github.payload.repository.full_name }} @@ -56,7 +56,7 @@ Command processing setup is complete! Now we need to setup command dispatch for runs-on: ubuntu-latest steps: - name: Slash Command Dispatch - uses: peter-evans/slash-command-dispatch@v2 + uses: peter-evans/slash-command-dispatch@v3 with: token: ${{ secrets.PAT }} commands: example diff --git a/docs/updating.md b/docs/updating.md index 9c6cb60..e4bfe43 100644 --- a/docs/updating.md +++ b/docs/updating.md @@ -1,3 +1,15 @@ +## Updating from `v2` to `v3` + +### Breaking changes + +- If using self-hosted runners or GitHub Enterprise Server, there are minimum requirements for `v4` to run. See "What's new" below for details. + +### What's new + +- Updated runtime to Node.js 16 + - The action now requires a minimum version of v2.285.0 for the [Actions Runner](https://github.com/actions/runner/releases/tag/v2.285.0). + - If using GitHub Enterprise Server, the action requires [GHES 3.4](https://docs.github.com/en/enterprise-server@3.4/admin/release-notes) or later. + ## Updating from `v1` to `v2` ### Breaking changes diff --git a/docs/workflow-dispatch.md b/docs/workflow-dispatch.md index 8a1640a..a4227cc 100644 --- a/docs/workflow-dispatch.md +++ b/docs/workflow-dispatch.md @@ -36,7 +36,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Slash Command Dispatch - uses: peter-evans/slash-command-dispatch@v2 + uses: peter-evans/slash-command-dispatch@v3 with: token: ${{ secrets.PAT }} commands: | @@ -85,7 +85,7 @@ The simplest response is to add a :tada: reaction to the comment. ```yml - name: Add reaction - uses: peter-evans/create-or-update-comment@v1 + uses: peter-evans/create-or-update-comment@v2 with: token: ${{ secrets.PAT }} repository: ${{ github.event.inputs.repository }} @@ -107,7 +107,7 @@ The `error-message` output can be used to provide feedback to the user as follow ```yml - name: Slash Command Dispatch id: scd - uses: peter-evans/slash-command-dispatch@v2 + uses: peter-evans/slash-command-dispatch@v3 with: token: ${{ secrets.PAT }} commands: | @@ -118,7 +118,7 @@ The `error-message` output can be used to provide feedback to the user as follow - name: Edit comment with error message if: steps.scd.outputs.error-message - uses: peter-evans/create-or-update-comment@v1 + uses: peter-evans/create-or-update-comment@v2 with: comment-id: ${{ github.event.comment.id }} body: |