Skip to content

Commit

Permalink
bump version in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hmarr committed Feb 3, 2024
1 parent 6eba12c commit 5c6d6d8
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

Automatically approve GitHub pull requests.

**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.
**Important:** use v4 or later, as earlier versions use deprecated versions of node. If you're on an old version of GHES (with an old version of the node interpreter) you may need to use an easier version until you can upgrade.

## Usage instructions

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:
Create a workflow file (e.g. `.github/workflows/auto-approve.yml`) that contains a step that `uses: hmarr/auto-approve-action@v4`. Here's an example workflow file:

```yaml
name: Auto approve
Expand All @@ -22,7 +22,7 @@ jobs:
permissions:
pull-requests: write
steps:
- uses: hmarr/auto-approve-action@v3
- uses: hmarr/auto-approve-action@v4
```
Combine with an `if` clause to only auto-approve certain users. For example, to auto-approve [Dependabot][dependabot] pull requests, use:
Expand All @@ -39,7 +39,7 @@ jobs:
pull-requests: write
if: github.actor == 'dependabot[bot]'
steps:
- uses: hmarr/auto-approve-action@v3
- uses: hmarr/auto-approve-action@v4
```

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:
Expand All @@ -60,7 +60,7 @@ jobs:
permissions:
pull-requests: write
steps:
- uses: hmarr/auto-approve-action@v3
- uses: hmarr/auto-approve-action@v4
with:
pull-request-number: ${{ github.event.inputs.pullRequestNumber }}
```
Expand All @@ -79,7 +79,7 @@ jobs:
pull-requests: write
if: github.actor == 'dependabot[bot]'
steps:
- uses: hmarr/auto-approve-action@v3
- uses: hmarr/auto-approve-action@v4
with:
review-message: "Auto approved automated PR"
```
Expand All @@ -99,7 +99,7 @@ jobs:
auto-approve:
runs-on: ubuntu-latest
steps:
- uses: hmarr/auto-approve-action@v3
- uses: hmarr/auto-approve-action@v4
with:
github-token: ${{ secrets.SOME_USERS_PAT }}
```
Expand All @@ -122,4 +122,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. `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`).
Each major version corresponds to a branch (e.g. `v3`, `v4`). The latest major version (`v4` at the time of writing) is the repository's default branch. Releases are tagged with semver-style version numbers (e.g. `v1.2.3`).

0 comments on commit 5c6d6d8

Please sign in to comment.