From 0474e12818d98665ba0fb2001ef8fb33704cdf80 Mon Sep 17 00:00:00 2001 From: Harry Marr Date: Fri, 14 Oct 2022 10:37:21 -0400 Subject: [PATCH] Start v3 branch --- README.md | 16 ++++++++-------- package.json | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index afe078a..15468e3 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ Automatically approve GitHub pull requests. -**Important:** use v2 or later, as v1 was designed for the initial GitHub Actions beta, and no longer works. +**Important:** use v3 or later, as v2 uses Node.js 12, which is deprecated. If you're on an old version of GHES (earlier than 3.4) you may need to use v2 until you can upgrade. v1 was designed for the initial GitHub Actions beta, and no longer works. ## Usage instructions -Create a workflow file (e.g. `.github/workflows/auto-approve.yml`) that contains a step that `uses: hmarr/auto-approve-action@v2`. Here's an example workflow file: +Create a workflow file (e.g. `.github/workflows/auto-approve.yml`) that contains a step that `uses: hmarr/auto-approve-action@v3`. Here's an example workflow file: ```yaml name: Auto approve @@ -20,7 +20,7 @@ jobs: permissions: pull-requests: write steps: - - uses: hmarr/auto-approve-action@v2 + - uses: hmarr/auto-approve-action@v3 ``` Combine with an `if` clause to only auto-approve certain users. For example, to auto-approve [Dependabot][dependabot] pull requests, use: @@ -37,7 +37,7 @@ jobs: pull-requests: write if: github.actor == 'dependabot[bot]' steps: - - uses: hmarr/auto-approve-action@v2 + - uses: hmarr/auto-approve-action@v3 ``` If you want to use this action from a workflow file that doesn't run on the `pull_request` or `pull_request_target` events, use the `pull-request-number` input: @@ -57,7 +57,7 @@ jobs: permissions: pull-requests: write steps: - - uses: hmarr/auto-approve-action@v2 + - uses: hmarr/auto-approve-action@v3 with: pull-request-number: ${{ github.event.inputs.pullRequestNumber }} ``` @@ -76,7 +76,7 @@ jobs: pull-requests: write if: github.actor == 'dependabot[bot]' steps: - - uses: hmarr/auto-approve-action@v2 + - uses: hmarr/auto-approve-action@v3 with: review-message: "Auto approved automated PR" ``` @@ -96,7 +96,7 @@ jobs: auto-approve: runs-on: ubuntu-latest steps: - - uses: hmarr/auto-approve-action@v2 + - uses: hmarr/auto-approve-action@v3 with: github-token: ${{ secrets.SOME_USERS_PAT }} ``` @@ -119,4 +119,4 @@ If you're using a [CODEOWNERS file](https://docs.github.com/en/github/creating-c ## Development and release process -Each major version corresponds to a branch (e.g. `v1`, `v2`). The latest major version (`v2` at the time of writing) is the repository's default branch. Releases are tagged with semver-style version numbers (e.g. `v1.2.3`). +Each major version corresponds to a branch (e.g. `v2`, `v3`). The latest major version (`v3` at the time of writing) is the repository's default branch. Releases are tagged with semver-style version numbers (e.g. `v1.2.3`). diff --git a/package.json b/package.json index fc56827..3863b71 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "auto-approve-action", - "version": "2.1.0", + "version": "3.0.0", "description": "Automatically approve pull requests", "main": "dist/main.ts", "scripts": {