Skip to content

wp-cli/.github

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

wp-cli/.github

🌐 Centralized community health files for all repositories

Quick links: Using | Installing | Contributing | Support

Using

This package cannot be used directly. It is a container to provide centralized fallback for community health files for the wp-cli Github organization.

See: https://help.github.com/en/articles/creating-a-default-community-health-file-for-your-organization

GitHub Actions Workflows

This repository contains reusable GitHub Actions workflows that are automatically synced to all WP-CLI repositories:

  • Code Quality Checks (code-quality.yml) - Runs linting, PHPCS, PHPStan, and other code quality tools
  • Regenerate README (regenerate-readme.yml) - Automatically regenerates README.md files from source
  • Check Branch Alias (check-branch-alias.yml) - Monitors and updates Composer branch-alias configuration

Branch Alias Checker

The branch alias checker workflow automatically ensures that the Composer branch-alias in each repository's composer.json is up-to-date. It:

  1. Runs weekly (every Monday at 2 AM UTC) or can be triggered manually
  2. Checks the latest release tag
  3. Calculates the expected branch-alias (next minor version after the latest release)
  4. Compares with the current branch-alias
  5. Creates a pull request if an update is needed

For example, if a repository has released version 2.12.0, the branch-alias should be set to 2.13.x-dev to point to the next development version.

Installing

There's nothing to install, this package cannot be used directly.

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.

For a more thorough introduction, check out WP-CLI's guide to contributing. This package follows those policy and guidelines.

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. Include as much detail as you can, and clear steps to reproduce if possible. For more guidance, review our bug report documentation.

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. See "Setting up" for details specific to working on this package locally.

Support

Github issues aren't for general support questions, but there are other venues you can try: https://wp-cli.org/#support

About

🌐 Centralized community health files for all repositories

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 12