Add php_version action input with 5.4-7.4 validation

Author: MekDrop

README.md

@@ -26,6 +26,7 @@ jobs:
       - name: Generating documentation...
         uses: impresscms-dev/generate-phpdocs-with-evert-phpdoc-md-action@v1.0.0
         with:
+          php_version: '7.4'
           output_path: ./docs/
           ignored_files: |
             test/
@@ -42,6 +43,7 @@ jobs:
 This action supports such arguments (used in `with` keyword):
 | Argument    | Required | Default value        | Description                       |
 |-------------|----------|----------------------|-----------------------------------|
+| php_version | No | 7.4 | PHP version to run (accepted range: `5.4` to `7.4`, inclusive) |
 | ignored_files | No      |                      | Defines files that can be ignored (supports glob rules; each line means one rule) |
 | phpdocumentor_version | No | v2.8.5 | What [phpDocumentor](https://www.phpdoc.org) version to use (latest or release tag like `v2.8.5`) |
 | output_path | Yes | | Path where to write generated documentation |
@@ -51,6 +53,7 @@ This action supports such arguments (used in `with` keyword):
 - Docker build clones `git@github.com:evert/phpdoc-md.git` directly and falls back to HTTPS clone when SSH credentials are not available.
 - phpDocumentor release artifacts are downloaded during action runtime and are not stored in this repository.
 - Dockerfile supports selecting PHP by version: `docker build --build-arg PHP_VERSION=7.4 .`
+- `php_version` input must match the container runtime version (this image version is controlled by `PHP_VERSION` build arg).
 - Tests are JavaScript integration tests based on [testcontainers-node](https://github.com/testcontainers/testcontainers-node).
 
 ## How to contribute? 

action.yml

@@ -6,6 +6,10 @@ branding:
   color: red
 
 inputs:
+  php_version:
+    description: "PHP version to run (must be between 5.4 and 7.4 inclusive)"
+    required: false
+    default: '7.4'
   ignored_files:
     description: "Defines files that can be ignored (supports glob rules; each line means one rule)"
     required: false
@@ -22,6 +26,7 @@ runs:
   using: 'docker'
   image: 'Dockerfile'
   args:
+    - ${{ inputs.php_version }}
     - ${{ inputs.output_path }}
     - ${{ inputs.ignored_files }}
     - ${{ inputs.phpdocumentor_version }}

bin/entrypoint.sh

@@ -2,9 +2,20 @@
 
 set -euo pipefail
 
-OUTPUT_PATH=${1:-}
-IGNORED_FILES=${2:-}
-PHPDOC_VERSION=${3:-v2.8.5}
+REQUESTED_PHP_VERSION=${1:-7.4}
+OUTPUT_PATH=${2:-}
+IGNORED_FILES=${3:-}
+PHPDOC_VERSION=${4:-v2.8.5}
+
+if ! php -r '$version = isset($argv[1]) ? $argv[1] : ""; if (!preg_match("/^(5\\.[4-6]|7\\.[0-4])$/", $version)) { fwrite(STDERR, "Input '\''php_version'\'' must be between 5.4 and 7.4 (inclusive).\n"); exit(1); }' "$REQUESTED_PHP_VERSION"; then
+  exit 1
+fi
+
+RUNTIME_PHP_VERSION=$(php -r 'echo PHP_MAJOR_VERSION . "." . PHP_MINOR_VERSION;')
+if [[ "$REQUESTED_PHP_VERSION" != "$RUNTIME_PHP_VERSION" ]]; then
+  echo "Input 'php_version' is '$REQUESTED_PHP_VERSION' but action container uses PHP '$RUNTIME_PHP_VERSION'. Build the action image with matching PHP_VERSION." >&2
+  exit 1
+fi
 
 if [[ -z "$OUTPUT_PATH" ]]; then
   echo "Input 'output_path' is required." >&2

tests/action-container.test.js

@@ -67,7 +67,7 @@ async function buildActionImage(phpVersion) {
   return imageTag;
 }
 
-async function runAction(actionImage, ignoredFiles, phpDocumentorVersion) {
+async function runAction(actionImage, phpVersion, ignoredFiles, phpDocumentorVersion) {
   const workspacePath = await mkdtemp(path.join(os.tmpdir(), "phpdoc-action-workspace-"));
 
   await cp(fixtureProjectPath, workspacePath, { recursive: true });
@@ -101,6 +101,7 @@ async function runAction(actionImage, ignoredFiles, phpDocumentorVersion) {
     startedContainer = await container.start();
     const execResult = await startedContainer.exec([
       "/usr/local/bin/entrypoint.sh",
+      phpVersion,
       "docs",
       ignoredFiles,
       phpDocumentorVersion
@@ -162,7 +163,7 @@ const phpDocumentorVersion = process.env.PHPDOC_VERSION || "v2.8.5";
 
 test(`boots container and generates markdown (php:${phpVersion}-cli)`, async () => {
   const actionImage = await buildActionImage(phpVersion);
-  const { docsOutputPath, workspacePath } = await runAction(actionImage, "", phpDocumentorVersion);
+  const { docsOutputPath, workspacePath } = await runAction(actionImage, phpVersion, "", phpDocumentorVersion);
 
   try {
     const indexStat = await stat(path.join(docsOutputPath, "ApiIndex.md"));