Skip to content

Commit

Permalink
Docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
johnbillion committed Nov 25, 2024
1 parent 5a514d1 commit 3e8eac6
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,55 @@ Provided without support, warranty, guarantee, backwards compatibility, fitness
* [User Switching](https://github.com/johnbillion/user-switching)
* [WP Crontrol](https://github.com/johnbillion/wp-crontrol)

## Overview

Plugins that use this library all use a similar setup in their workflows:

### Acceptance testing

* Push to a main branch or pull request, `acceptance-tests.yml` fires
* Constructs a matrix of supported PHP and WordPress versions
* Uses `reusable-acceptance-tests.yml`
* Installs PHP and WordPress
* Runs the build
* Runs acceptance testing with wp-browser

### Integration testing

* Push to a main branch or pull request, `integration-tests.yml` fires
* Constructs a matrix of supported PHP and WordPress versions
* Uses `reusable-integration-tests.yml`
* Installs PHP and WordPress
* Runs the build
* Runs integration testing with wp-browser

### Coding standards testing

* Push to a main branch or pull request, `coding-standards.yml` fires
* Constructs a matrix of supported PHP versions
* Uses `reusable-coding-standards.yml`
* Installs PHP
* Checks coding standards with PHPStan and PHPCS

### Deployment to WordPress.org

* Push to the `release` branch, `build.yml` fires
* Uses `reusable-build.yml`
* Runs the build
* Reads version from `package.json`
* Commits built files
* Pushes to `release-$VERSION`
* Tags the new version and pushes
* Publish a release, `deploy-tag.yml` fires
* Uses `reusable-deploy-tag.yml`
* Creates a changelog entry from the release notes
* Uses `10up/action-wordpress-plugin-deploy`
* Deploys the new version to WordPress.org
* Generates a zip file
* Uses `johnbillion/action-wordpress-plugin-attestation`
* Fetches the zip from WordPress.org
* Generates an attestation if the zip contents match the build

## Licence

MIT

0 comments on commit 3e8eac6

Please sign in to comment.