Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/automattic/wpvip-plugins-.github
Central hub for reusable workflow and other files for WordPress VIP plugins.
https://github.com/automattic/wpvip-plugins-.github
vip
Last synced: 3 months ago
JSON representation
Central hub for reusable workflow and other files for WordPress VIP plugins.
- Host: GitHub
- URL: https://github.com/automattic/wpvip-plugins-.github
- Owner: Automattic
- License: mit
- Created: 2023-06-29T14:49:38.000Z (over 1 year ago)
- Default Branch: trunk
- Last Pushed: 2023-08-20T01:57:28.000Z (over 1 year ago)
- Last Synced: 2024-10-07T11:18:56.242Z (3 months ago)
- Topics: vip
- Homepage: https://wpvip.com
- Size: 35.2 KB
- Stars: 4
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WordPress VIP Plugins Hub
Central hub for reusable workflows and similarly common files for WordPress VIP plugins.
This repository contains:
- Reusable workflows that can apply to all of the WordPress VIP plugins, such as running PHPUnit or Behat tests, or PHPCS.
- A collection of files that individual plugin repositories should have, such as `.editorconfig`, or GitHub Workflow files that reference the reusable workflow files.
- A synchronization workflow that runs automatically to sync the colletion of files down to the individual plugin repos.
## Why?
Previously, workflows across 10+ repositories would all need updating when a new version of PHP, or GitHub Action was available.
Having the common workflows in one location means that they can be updated far more easily, and the repos have a consistency that they would otherwise be missing. The process of syncing the standalone files, such as "local" workflows, also avoids having to update individual repositories to get them using the centralized code.
## Won't things break if a plugin isn't using a feature?
Hopefully not! As an example, not all of the WordPress VIP plugins use Behat for functional tests - but the reusable workflows include checks to see if the individual repo has some key config files (such as `composer.json` and `behat.yml`), and the workflow won't run if they aren't found. Repeat for `.phpcs.xml.dist`, `phpunit.xml.dist` and so on.
## How do I install this package?
You don't - there's nothing to install, and it's only used to communicate with other repositories.
## How are other plugin repositories added into the sync process?
Three steps are needed:
- Add the bot account with Write access to the new plugin repository.
- If the default branch is protected, add the bot account to the list of accounts that can bypass needing to create a pull request, and the list of those who can push to the branch.
- Add the name of the repository to the list of targets in the sync workflow.
Once committed and pushed, this will trigger the sync workflow to start and the new repository will be updated.
## How do I add new files to be synced down?
- Add them to this repository in the file path that you want them in the plugin repositories.
- Make sure that any reusable workflows have defensive checks so that they don't break on repositories that aren't using a feature/tool.
- Add the file name(s) to the sync workflow.
## Who came up with this idea?
The WP-CLI organization has a central [set of resusable workflows](https://github.com/wp-cli/.github/tree/main/.github/workflows) and synchronization workflows, so all credit goes to the WP-CLI maintainers and whoever they got the idea from.