GitHub Action
PHP-Prefixer
The PHP Prefixer Build Action integrates the PHP-Prefixer service with GitHub Actions.
PHP-Prefixer is a service to apply PHP prefixes to namespaces, functions, helpers, traits, interfaces, etc. You start with a Composer project and a set of dependencies and prefix all library files at once to generate a consistent prefixed codebase.
PHP-Prefixer abstracts the complexity of manually applying prefixes to PHP files. The service automates and streamlines the process of prefixing while providing the scalability and simplicity of serverless computing.
PHP-Prefixer is a rule-based expert system that processes the project and dependencies iteratively to prefix every project file.
Here is a sample class declaration:
namespace ACME\Carbon;
use ACME\Carbon\Exceptions\InvalidDateException;
use DateInterval;
use ACME\Symfony\Component\Translation;
class Carbon extends DateTime
{
const NO_ZERO_DIFF = 01;
...The associated prefixed class declaration, with a new and distinct namespace ACME:
namespace ACME\Carbon;
use ACME\Carbon\Exceptions\InvalidDateException;
use DateInterval;
use ACME\Symfony\Component\Translation;
class Carbon extends DateTime
{
const NO_ZERO_DIFF = 01;
...An example repository has been created at https://github.com/PHP-Prefixer/hello-wp-world to show how to use this Action in a real project. The repository depends on a private dependency and uses GitHub PAT/Personal Access Tokens for authentication.
To use the Action, you must create an account on PHP-Prefixer and prepare your projects with the prefix defined in the composer.json schema. You can first prefix your project on the service web interface and then integrate Action in your repositories. Before using the Action and the command-line, we recommend checking the documentation and guides here: https://php-prefixer.com/docs/guides/.
Create your Github Workflow configuration in .github/workflows/prefixer.yml.
name: Prefixer
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Run PHP-Prefixer
uses: PHP-Prefixer/[email protected]
with:
personal_access_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
project_id: ${{ secrets.PROJECT_ID }}
token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
# ... then your own project steps ...The Action requires two parameters to function, and it can receive additional parameters for GitHub integration:
| Parameter | Description | Required | Example |
|---|---|---|---|
| PERSONAL_ACCESS_TOKEN | The PHP-Prefixer PAT/Personal Access Token. The token must be configured in the PHP-Prefixer account. | Yes | 789|123456789... |
| PROJECT_ID | The project ID to process the source code. The project must be configured in your account in the PHP-Prefixer account. | Yes | 5432 |
| TOKEN | The GitHub PAT/Personal Access Token to access private repositories. It is only required if the project, the library or the dependencies are private. | No | ghp_F4fZ9Cq7QF... |
The Action integrates the GitHub Action Checkout - actions/checkout. The following parameters are also available:
# Repository name with owner. For example, actions/checkout
# Default: ${{ github.repository }}
repository: ''
# The branch, tag or SHA to checkout. When checking out the repository that
# triggered a workflow, this defaults to the reference or SHA for that event.
# Otherwise, uses the default branch.
ref: ''
# Personal access token (PAT) used to fetch the repository. The PAT is configured
# with the local git config, which enables your scripts to run authenticated git
# commands. The post-job step removes the PAT.
#
# We recommend using a service account with the least permissions necessary. Also
# when generating a new PAT, select the least scopes necessary.
#
# [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
#
# Default: ${{ github.token }}
token: ''
# SSH key used to fetch the repository. The SSH key is configured with the local
# git config, which enables your scripts to run authenticated git commands. The
# post-job step removes the SSH key.
#
# We recommend using a service account with the least permissions necessary.
#
# [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
ssh-key: ''
# Known hosts in addition to the user and global host key database. The public SSH
# keys for a host may be obtained using the utility `ssh-keyscan`. For example,
# `ssh-keyscan github.com`. The public key for github.com is always implicitly
# added.
ssh-known-hosts: ''
# Whether to perform strict host key checking. When true, adds the options
# `StrictHostKeyChecking=yes` and `CheckHostIP=no` to the SSH command line. Use
# the input `ssh-known-hosts` to configure additional hosts.
# Default: true
ssh-strict: ''
# Whether to download Git-LFS files
# Default: false
lfs: ''
# Whether to checkout submodules: `true` to checkout submodules or `recursive` to
# recursively checkout submodules.
#
# When the `ssh-key` input is not provided, SSH URLs beginning with
# `[email protected]:` are converted to HTTPS.
#
# Default: false
submodules: ''Follow these steps to prefix private repositories:
- Step 1: Create a GitHub Personal Access Token for the Github account you wish to authenticate with.
- Step 2: Next, add the GitHub Personal Access Token to your project using Github Secrets, and pass it into the Action using the input.
Example yaml, showing how to pass secrets:
jobs:
build:
...
- name: Run PHP-Prefixer
uses: PHP-Prefixer/[email protected]
with:
personal_access_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
project_id: ${{ secrets.PROJECT_ID }}
token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}There is an example repository available for reference at https://github.com/PHP-Prefixer/hello-wp-world that uses a private dependency. Check it out for a live project.
This Action is released with semantic version numbers and tags. The latest major release's tag always points to the latest release within the matching major version.
Please feel free to use uses: PHP-Prefixer/php-prefixer-build-action@v1 to run the latest version of v1, or uses: PHP-Prefixer/[email protected] to specify the exact Action’s version.
If you found this repository helpful, please consider upvoting the product on ProductHunt.
- PHP-Prefixer: https://php-prefixer.com/
- Documentation: https://php-prefixer.com/docs
- Config Reference: https://php-prefixer.com/docs/config/
- API: https://php-prefixer.com/docs/rest-api-reference/
- Command Line: https://php-prefixer.com/docs/command-line/
- Aníbal Sánchez
- PHP-Prefixer, Desarrollos Inteligentes Virtuales, SL.