Fix workflow runtime resolution and CLI invocations

Author: coisa

.github/actions/changelog/create-dependabot-entry/run.sh

@@ -9,7 +9,7 @@ git switch -C "${INPUT_HEAD_REF}" "refs/remotes/origin/${INPUT_HEAD_REF}"
 git config user.name "github-actions[bot]"
 git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
 
-if dev-tools changelog:check -- --file="${INPUT_CHANGELOG_FILE}" --against="origin/${INPUT_BASE_REF}" >/dev/null 2>&1; then
+if dev-tools changelog:check --file="${INPUT_CHANGELOG_FILE}" --against="origin/${INPUT_BASE_REF}" >/dev/null 2>&1; then
     {
         echo "created=false"
         echo "status=already-present"
@@ -19,7 +19,7 @@ if dev-tools changelog:check -- --file="${INPUT_CHANGELOG_FILE}" --against="orig
     exit 0
 fi
 
-dev-tools changelog:entry -- --type=changed --file="${INPUT_CHANGELOG_FILE}" "${entry_message}"
+dev-tools changelog:entry --type=changed --file="${INPUT_CHANGELOG_FILE}" "${entry_message}"
 git add "${INPUT_CHANGELOG_FILE}"
 
 if git diff --cached --quiet -- "${INPUT_CHANGELOG_FILE}"; then
@@ -35,7 +35,7 @@ fi
 git commit -m "Add changelog entry for Dependabot PR #${INPUT_PULL_REQUEST_NUMBER}"
 git push origin "HEAD:${INPUT_HEAD_REF}"
 
-if ! dev-tools changelog:check -- --file="${INPUT_CHANGELOG_FILE}" --against="origin/${INPUT_BASE_REF}" >/dev/null 2>&1; then
+if ! dev-tools changelog:check --file="${INPUT_CHANGELOG_FILE}" --against="origin/${INPUT_BASE_REF}" >/dev/null 2>&1; then
     {
         echo "created=false"
         echo "status=missing"

.github/actions/changelog/render-release-notes/run.sh

@@ -2,4 +2,4 @@
 set -euo pipefail
 
 mkdir -p "$(dirname "${INPUT_OUTPUT_FILE}")"
-dev-tools changelog:show -- "${INPUT_VERSION}" --file="${INPUT_CHANGELOG_FILE}" > "${INPUT_OUTPUT_FILE}"
+dev-tools changelog:show "${INPUT_VERSION}" --file="${INPUT_CHANGELOG_FILE}" > "${INPUT_OUTPUT_FILE}"

.github/actions/changelog/resolve-version/run.sh

@@ -5,7 +5,7 @@ if [ -n "${INPUT_VERSION}" ]; then
     version="${INPUT_VERSION}"
     source="input"
 else
-    version="$(dev-tools changelog:next-version -- --file="${INPUT_CHANGELOG_FILE}")"
+    version="$(dev-tools changelog:next-version --file="${INPUT_CHANGELOG_FILE}")"
     source="inferred"
 fi
 

.github/actions/php/setup-composer/dev-tools-runtime-lib.sh

@@ -12,6 +12,25 @@ resolve_dev_tools_workspace_path() {
     printf '%s/%s\n' "$(pwd)" "${input_path#./}"
 }
 
+workspace_is_dev_tools_repository() {
+    local workspace_root="${1:?Workspace root is required}"
+    local composer_json="${workspace_root}/composer.json"
+
+    if [ ! -f "${composer_json}" ]; then
+        return 1
+    fi
+
+    php -r '
+        $composer = json_decode((string) file_get_contents($argv[1]), true);
+
+        if (! is_array($composer)) {
+            exit(1);
+        }
+
+        exit(($composer["name"] ?? null) === "fast-forward/dev-tools" ? 0 : 1);
+    ' "${composer_json}"
+}
+
 resolve_dev_tools_runtime() {
     local source_directory_input="${INPUT_DEV_TOOLS_SOURCE_DIRECTORY:-.dev-tools-actions}"
 
@@ -29,7 +48,7 @@ resolve_dev_tools_runtime() {
         return 0
     fi
 
-    if [ -x "${DEV_TOOLS_LOCAL_REPOSITORY_BINARY}" ] && [ -f "${DEV_TOOLS_LOCAL_AUTOLOAD}" ]; then
+    if [ -x "${DEV_TOOLS_LOCAL_REPOSITORY_BINARY}" ] && [ -f "${DEV_TOOLS_LOCAL_AUTOLOAD}" ] && workspace_is_dev_tools_repository "${DEV_TOOLS_WORKSPACE_ROOT}"; then
         DEV_TOOLS_RUNTIME_SOURCE='local'
         DEV_TOOLS_RUNTIME_BINARY="${DEV_TOOLS_LOCAL_REPOSITORY_BINARY}"
         DEV_TOOLS_RUNTIME_AUTOLOAD="${DEV_TOOLS_LOCAL_AUTOLOAD}"
@@ -43,8 +62,8 @@ resolve_dev_tools_runtime() {
         return 1
     fi
 
-    if [ ! -f "${DEV_TOOLS_SOURCE_DIRECTORY}/composer.json" ]; then
-        echo "The DevTools workflow source directory does not contain composer.json: ${DEV_TOOLS_SOURCE_DIRECTORY}" >&2
+    if ! workspace_is_dev_tools_repository "${DEV_TOOLS_SOURCE_DIRECTORY}"; then
+        echo "The DevTools workflow source directory does not point to the fast-forward/dev-tools package: ${DEV_TOOLS_SOURCE_DIRECTORY}" >&2
         echo "Checkout the full php-fast-forward/dev-tools source into ${source_directory_input} before using this action." >&2
 
         return 1

.github/workflows/changelog.yml

@@ -131,7 +131,7 @@ jobs:
                   pull-request-title: ${{ env.PULL_REQUEST_TITLE }}
 
             - name: Verify changelog update
-              run: dev-tools changelog:check -- --file="${CHANGELOG_FILE}" --against="origin/${BASE_REF}"
+              run: dev-tools changelog:check --file="${CHANGELOG_FILE}" --against="origin/${BASE_REF}"
 
             - uses: ./.dev-tools-actions/.github/actions/summary/write
               with:
@@ -217,7 +217,7 @@ jobs:
                   RELEASE_VERSION: ${{ steps.version.outputs.value }}
               run: |
                   release_date="$(date -u +%F)"
-                  dev-tools changelog:promote -- "${RELEASE_VERSION}" --file="${CHANGELOG_FILE}" --date="${release_date}"
+                  dev-tools changelog:promote "${RELEASE_VERSION}" --file="${CHANGELOG_FILE}" --date="${release_date}"
 
             - name: Render release notes preview
               uses: ./.dev-tools-actions/.github/actions/changelog/render-release-notes

.github/workflows/reports.yml

@@ -89,7 +89,7 @@ jobs:
             - name: Generate reports
               env:
                 COMPOSER_ROOT_VERSION: ${{ env.REPORTS_ROOT_VERSION }}
-              run: dev-tools reports -- --target="${REPORTS_TARGET}" --coverage="${REPORTS_TARGET}/coverage" --metrics="${REPORTS_TARGET}/metrics"
+              run: dev-tools reports --target="${REPORTS_TARGET}" --coverage="${REPORTS_TARGET}/coverage" --metrics="${REPORTS_TARGET}/metrics"
 
             - name: Fix permissions
               run: |

.github/workflows/tests.yml

@@ -116,7 +116,7 @@ jobs:
             - name: Run PHPUnit tests
               env:
                 COMPOSER_ROOT_VERSION: ${{ env.TESTS_ROOT_VERSION }}
-              run: dev-tools tests -- --coverage=.dev-tools/coverage --min-coverage=${{ steps.minimum-coverage.outputs.value }}
+              run: dev-tools tests --coverage=.dev-tools/coverage --min-coverage=${{ steps.minimum-coverage.outputs.value }}
 
             - name: Publish required test status
               if: ${{ always() && inputs.publish-required-statuses }}
@@ -168,7 +168,7 @@ jobs:
             - name: Run dependency health check
               env:
                 COMPOSER_ROOT_VERSION: ${{ env.TESTS_ROOT_VERSION }}
-              run: dev-tools dependencies -- --max-outdated=${{ inputs.max-outdated || -1 }}
+              run: dev-tools dependencies --max-outdated=${{ inputs.max-outdated || -1 }}
 
     summarize:
         if: ${{ always() }}

.github/workflows/wiki-preview.yml

@@ -77,7 +77,7 @@ jobs:
       - name: Create Docs Markdown
         env:
           COMPOSER_ROOT_VERSION: dev-${{ github.event.pull_request.head.ref }}
-        run: dev-tools wiki -- --target=.github/wiki
+        run: dev-tools wiki --target=.github/wiki
 
       - name: Commit & push wiki preview branch
         id: wiki_commit

tests/GitHubActions/SetupComposerActionTest.php

@@ -109,8 +109,7 @@ public function detectRuntimeWillPreferTheConsumerLocalInstallation(): void
     #[Test]
     public function detectRuntimeWillFallbackToTheWorkflowSourceWhenTheConsumerDoesNotInstallDevTools(): void
     {
-        mkdir($this->workspace . '/.dev-tools-actions', 0o777, true);
-        file_put_contents($this->workspace . '/.dev-tools-actions/composer.json', "{}\n");
+        $this->createRepositoryRuntimeFiles($this->workspace . '/.dev-tools-actions');
         $resolvedWorkspace = realpath($this->workspace);
 
         $files = $this->createGitHubActionFiles();
@@ -150,6 +149,30 @@ public function detectRuntimeWillPreferTheWorkspaceRootRepositoryCheckout(): voi
         self::assertSame($resolvedWorkspace . '/vendor/autoload.php', $outputs['autoload']);
     }
 
+    /**
+     * @return void
+     */
+    #[Test]
+    public function detectRuntimeWillIgnoreAnUnrelatedWorkspaceRepositoryBinary(): void
+    {
+        $this->createRepositoryRuntimeFiles($this->workspace, 'example/consumer');
+        $this->createRepositoryRuntimeFiles($this->workspace . '/.dev-tools-actions');
+        $resolvedWorkspace = realpath($this->workspace);
+
+        $files = $this->createGitHubActionFiles();
+
+        $this->runActionScript('detect-dev-tools-runtime.sh', [
+            'GITHUB_OUTPUT' => $files['output'],
+        ]);
+
+        $outputs = $this->parseKeyValueFile($files['output']);
+
+        self::assertSame('workflow', $outputs['source']);
+        self::assertSame('true', $outputs['needs-fallback']);
+        self::assertSame($resolvedWorkspace . '/.dev-tools-actions/bin/dev-tools', $outputs['binary']);
+        self::assertSame($resolvedWorkspace . '/.dev-tools-actions/vendor/autoload.php', $outputs['autoload']);
+    }
+
     /**
      * @return void
      */
@@ -209,19 +232,23 @@ private function createInstalledRuntimeFiles(string $runtimeRoot): void
     }
 
     /**
+     * @param string $packageName
      * @param string $runtimeRoot
      *
      * @return void
      */
-    private function createRepositoryRuntimeFiles(string $runtimeRoot): void
-    {
+    private function createRepositoryRuntimeFiles(
+        string $runtimeRoot,
+        string $packageName = 'fast-forward/dev-tools'
+    ): void {
         mkdir($runtimeRoot . '/bin', 0o777, true);
         mkdir($runtimeRoot . '/vendor', 0o777, true);
         file_put_contents(
             $runtimeRoot . '/bin/dev-tools',
             "#!/usr/bin/env bash\nprintf 'dev-tools:%s\\n' \"\$*\"\n",
         );
         chmod($runtimeRoot . '/bin/dev-tools', 0o755);
+        file_put_contents($runtimeRoot . '/composer.json', \sprintf("{\n    \"name\": \"%s\"\n}\n", $packageName));
         file_put_contents($runtimeRoot . '/vendor/autoload.php', "<?php\n");
     }