docs(readme): Document the action

Author: anibalsanchez

Dockerfile

@@ -1,5 +1,17 @@
+# @package     PHP Prefixer Build Action
+#
+# @author      PHP Prefixer <team@php-prefixer.com>
+# @copyright   Copyright (c)2019-2021 Desarrollos Inteligentes Virtuales, SL. All rights reserved.
+# @license     MIT
+#
+# @see         https://php-prefixer.com
+
+#
 # https://github.com/docker-library/php/blob/d2b630dc89b257cb80d6fc99e177caae152830b8/8.0/buster/cli/Dockerfile
-FROM php:8.0.9-cli
+# https://hub.docker.com/_/php
+#
+
+FROM php:8.0-cli
 RUN curl -sSfL -o /php-prefixer-cli.phar 'https://github.com/PHP-Prefixer/php-prefixer-cli/releases/download/0.0.6/php-prefixer-cli.phar' \
     && chmod +x php-prefixer-cli.phar \
     && curl -sSfL -o /usr/local/bin/composer 'https://getcomposer.org/composer.phar' \

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 PHP-Prefixer
+Copyright (c) 2021 PHP Prefixer / Desarrollos Inteligentes Virtuales, SL. <team@php-prefixer.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,3 +1,134 @@
-# PHP Prefixer Build Action
 
-Action for applying PHP prefixes to namespaces, functions, helpers, traits, interfaces, etc.
+<img src="https://php-prefixer.com/images/logo/php-prefixer-action_100.png" align="right" alt="PHP Prefixer Action for Github" />
+
+Use the PHP Prefixer CLI in your Github Actions
+============================================
+
+The **PHP Prefixer Build Action** integrates the [PHP-Prefixer](https://php-prefixer.com/) service with GitHub Actions.
+
+**PHP-Prefixer** is a service to apply PHP prefixes to namespaces, functions, helpers, traits, interfaces, etc. 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** with 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.
+
+Given this sample class declaration:
+
+```php
+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`:
+
+```php
+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://php-prefixer.com/docs/guides/how-to-prefix-wordpress-plugin-with-private-dep/ to show how to use this action in a real project. The repository also depends on a private dependency and uses GitHub PAT/Personal Access Tokens for authentication.
+
+## Usage
+
+To use the Action, you must create an account on [PHP-Prefixer](https://php-prefixer.com/) and prepare your projects with the prefix defined in the `composer.json` schema. Before using the Action and the command-line, we recommend checking the documentation and guides here: <https://php-prefixer.com/docs/>. You can also prefix your firsts projects on the service web interface.
+
+Create your Github Workflow configuration in `.github/workflows/prefixer.yml` or similar.
+
+```yaml
+name: Prefixer
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Run PHP-Prefixer
+        uses: PHP-Prefixer/php-prefixer-build-action@v0.0.1
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          personal_access_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+          project_id: ${{ secrets.PROJECT_ID }}
+    # ... then your own project steps ...
+```
+
+### Available Parameters
+
+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|1234567890123456789012345678901234567890`
+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`
+SOURCE_DIR_PATH | The relative path to the source project directory. It must contain a .git repository and composer.json file. If not, set the base repository directory will be used as the value. Example: `foo/bar`. | No | `./`
+TARGET_BRANCH | The branch in the repository where PHP-Prefixer will store the prefixed files after processing. | No | `prefixed`
+GH_PERSONAL_ACCESS_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 |
+
+## Prefixing Private Repositories
+
+To prefix from a private repository, GitHub PAT/Personal Access Tokens must be used. Generate a **Personal Access Token** for this purpose and add it to your private repository's configuration.
+
+Create a [Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) for the Github account you wish to authenticate with.
+
+Add the GitHub PAT/Personal Access Tokens to your project using  [Github Secrets][secrets], and pass them into the `PHP-Prefixer/php-prefixer-build-action` action by using the `gh_personal_access_token` input.
+
+Example yaml, showing how to pass secrets:
+
+```yaml
+jobs:
+  build:
+
+    ...
+
+      - name: Run PHP-Prefixer
+        uses: PHP-Prefixer/php-prefixer-build-action@v0.0.1
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          personal_access_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+          project_id: ${{ secrets.PROJECT_ID }}
+          gh_personal_access_token: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
+```
+
+There is an example repository available for reference at https://github.com/PHP-Prefixer/how-to-prefix-wordpress-plugin-with-private-dep that uses a private dependency. Check it out for a live working project.
+
+## Version Numbers
+
+This action is released with semantic version numbers and tagged, so 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 always run the latest version of v1, or `uses: PHP-Prefixer/php-prefixer-build-action@v1.0.0` to specify the exact release.
+
+***
+
+If you found this repository helpful, please consider [upvoting the product on ProductHunt](https://www.producthunt.com/posts/php-prefixer).
+
+## Additional Links
+
+- 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/
+
+[secrets]: https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets

action.yml

@@ -1,27 +1,34 @@
 name: PHP-Prefixer
-author: Put your name here
-description: 'Applies prefixes for PHP code stored in a specified directory'
+author: PHP Prefixer <team@php-prefixer.com>
+description: 'Action to prefix PHP libraries and projects. PHP-Prefixer is an automated online service powered by a complex rule-based system to apply prefixes to Composer dependencies. For information, please, visit https://php-prefixer.com.'
+
 inputs:
-  source_dir_path:
-    description: 'Relative path to source project directory. It must contain .git repository and composer.json file. If not set the base repository directory will be used as the value. Example: `foo/bar`'
-    required: false
-  target_branch:
-    description: todo
-    required: true
-    default: 'prefixed'
   personal_access_token:
-    description: 'PAT/Personal Access Token generated via the https://php-prefixer.com site, Example: `789|1234567890123456789012345678901234567890`'
+    description: 'The PHP-Prefixer PAT/Personal Access Token. The token must be configured in the PHP-Prefixer account. Example: `789|1234567890123456789012345678901234567890`.'
     required: true
+
   project_id:
-    description: 'The project ID to process the source code. Example: `5123`'
+    description: 'The project ID to process the source code. The project must be configured in your account in the PHP-Prefixer account. Example: `5123`.'
     required: true
+
+  source_dir_path:
+    description: 'The relative path to the source project directory. It must contain a .git repository and composer.json file. If not, set the base repository directory will be used as the value. Example: `foo/bar`.'
+    required: false
+
+  target_branch:
+    description: 'The branch in the repository where PHP-Prefixer will store the prefixed files after processing. By default: `prefixed`.'
+    required: false
+    default: 'prefixed'
+
   gh_personal_access_token:
-    description: 'GitHub PAT/Personal Access Token. Required for the private repository only'
+    description: 'The GitHub PAT/Personal Access Token to access private repositories. It is only required if the project, the library or the dependencies are private.'
     required: false
     default: ''
+
 runs:
   using: 'docker'
   image: 'Dockerfile'
+
 branding:
   icon: 'code'
   color: 'blue'

entrypoint.sh

@@ -1,5 +1,13 @@
 #!/usr/bin/env bash
 
+# @package     PHP Prefixer Build Action
+#
+# @author      PHP Prefixer <team@php-prefixer.com>
+# @copyright   Copyright (c)2019-2021 Desarrollos Inteligentes Virtuales, SL. All rights reserved.
+# @license     MIT
+#
+# @see         https://php-prefixer.com
+
 set -eu
 
 if [[ -z "$INPUT_SOURCE_DIR_PATH" ]]; then
@@ -35,7 +43,6 @@ initGitRepoForTargetDir() {
 
     readonly remote=tmp$(($(date +%s%N)/1000000))
 
-    #git checkout "$INPUT_TARGET_BRANCH" || git checkout -b "$INPUT_TARGET_BRANCH"git remote add "$remote" "https://$INPUT_TARGET_REPO_USER:$GITHUB_ACCESS_TOKEN@github.com/$GITHUB_REPOSITORY"
     git remote add "$remote" "https://x-access-token:$GH_TOKEN@github.com/$GITHUB_REPOSITORY"
 
     git fetch "$remote"