wp-cli/update-check
2
0
Fork 0
mirror of https://ghproxy.net/https://github.com/growella/update-check.git synced 2025-10-04 02:50:39 +08:00
Code Issues Packages Activity Actions
WP-CLI command to automatically check WordPress core and all installed themes and plugins for available updates
13 commits 2 branches 2 tags 64 KiB
Find a file
Steve Grunwell 10ce31e164 Arguments work a lot better when you actually involve them in the command
2017-03-13 18:10:57 -04:00
bin Initial commit of the wp update-check package for WP-CLI. 2017-02-24 12:09:13 -05:00
features Add the --report-current flag, which must be used to email reports of 'hey, everything is up-to-date. 2017-02-24 15:31:26 -05:00
utils Initial commit of the wp update-check package for WP-CLI. 2017-02-24 12:09:13 -05:00
.distignore Initial commit of the wp update-check package for WP-CLI. 2017-02-24 12:09:13 -05:00
.editorconfig Initial commit of the wp update-check package for WP-CLI. 2017-02-24 12:09:13 -05:00
.gitignore Initial commit of the wp update-check package for WP-CLI. 2017-02-24 12:09:13 -05:00
.travis.yml Drop PHP 5.3 from the testing matrix 2017-03-13 16:46:39 -04:00
CHANGELOG.md Add 0.1.1 to the CHANGELOG 2017-03-13 17:00:59 -04:00
command.php Arguments work a lot better when you actually involve them in the command 2017-03-13 18:10:57 -04:00
composer.json Initial commit of the wp update-check package for WP-CLI. 2017-02-24 12:09:13 -05:00
composer.lock Initial commit of the wp update-check package for WP-CLI. 2017-02-24 12:09:13 -05:00
phpcs.xml Initial commit of the wp update-check package for WP-CLI. 2017-02-24 12:09:13 -05:00
README.md Update installation instructions to install from GitHub, since the package index may be discontinued (per https://github.com/wp-cli/package-index/pull/105) 2017-03-13 16:58:12 -04:00
wp-cli.yml Initial commit of the wp update-check package for WP-CLI. 2017-02-24 12:09:13 -05:00

README.md

WP-CLI: Update Check

WP-CLI command to automatically check WordPress core and all installed themes and plugins for available updates.

Build Status

Quick links: Using | Installing | Contributing

Using

Update Check will check WordPress core, plugins, and themes for available updates, then generate a report. This can be displayed within the CLI or, with the optional --email argument, sent via email to the site administrator.

Default usage

If you'd like to be able to see what needs updating on your WordPress site at a glance, you can run the following on the command line:

$ wp update-check run

Emailed reports

If you'd prefer to generate an email to be sent, use the --email option:

# Send the report to johndoe@example.com.
$ wp update-check run --email=johndoe@example.com

# Send the report to the admin_email for the WP site.
$ wp update-check run --email

Note that a report will not be emailed if everything's up-to-date unless the --report-current flag is also passed.

# Email John Doe, even if everything is up-to-date.
$ wp update-check run --email=johndoe@example.com --report-current

Daily email reports

WP-CLI: Update Check is designed to work well with system cron jobs:

# Check for available updates and send them to the engineering team.
0 8 * * * /path/to/wp update-check run --email=engineering@example.com --path=/path/to/my/site --quiet

Installing

Installing this package requires WP-CLI v1.1.0 or greater. Update to the latest stable release with wp cli update.

Once you've done so, you can install this package with wp package install git@github.com:growella/update-check.git.

Contributing

We appreciate you taking the initiative to contribute to this project.

Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.

Reporting a bug

Think you’ve found a bug? We’d love for you to help us get it fixed.

Before you create a new issue, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.

Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please create a new issue with the following:

  1. What you were doing (e.g. "When I run wp post list").
  2. What you saw (e.g. "I see a fatal about a class being undefined.").
  3. What you expected to see (e.g. "I expected to see the list of posts.")

Include as much detail as you can, and clear steps to reproduce if possible.

Creating a pull request

Want to contribute a new feature? Please first open a new issue to discuss whether the feature is a good fit for the project.

Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience:

  1. Create a feature branch for each contribution.
  2. Submit your pull request early for feedback.
  3. Include functional tests with your changes. Read the WP-CLI documentation for an introduction.
  4. Follow the WordPress Coding Standards.