Skip to content

Commit

Permalink
Tidy README
Browse files Browse the repository at this point in the history
  • Loading branch information
AlecRust committed Apr 14, 2024
1 parent 09e600b commit 52fcbef
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- markdownlint-disable-next-line MD013 -->
# WordPress "Tested up to" Updater [![Lint](https://github.com/AlecRust/wp-tut-updater-action/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter) ![CI](https://github.com/AlecRust/wp-tut-updater-action/actions/workflows/ci.yml/badge.svg) [![CodeQL](https://github.com/AlecRust/wp-tut-updater-action/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/AlecRust/wp-tut-updater-action/actions/workflows/codeql-analysis.yml)

> Automate "Tested up to" version updates in your WordPress projects.
Expand All @@ -7,8 +8,7 @@ WordPress version then updates the "Tested up to" version of your WordPress
plugin or theme if it's out of date.

Run it based on a cron or manually via the Actions tab. Have the action create a
pull request for you to review and merge, or allow it to commit directly to your
default branch.
pull request, or allow it to commit directly to your default branch.

Never forget to update the "Tested up to" version of your WordPress plugin or
theme again!
Expand All @@ -34,13 +34,13 @@ permissions:
pull-requests: write

jobs:
check-tested-up-to:
update-tested-up-to:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Check for new "Tested up to" version
- name: Update "Tested up to" version
uses: AlecRust/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -53,7 +53,7 @@ Optionally you can specify paths to update which will override the default
`readme.txt` file:

```yaml
- name: Run wp-tut-updater-action
- name: Update "Tested up to" version
uses: AlecRust/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -63,11 +63,11 @@ Optionally you can specify paths to update which will override the default
my-other-file.php
```

If you want the action to commit directly to your default branch, you can set
Optionally the action can commit directly to your default branch by setting
`create-pr` to `false`:

```yaml
- name: Run wp-tut-updater-action
- name: Update "Tested up to" version
uses: AlecRust/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down

0 comments on commit 52fcbef

Please sign in to comment.