IBX-9904: Workflow to build API refs into new PR (#2723)

* Draft workflow to open API refs PR

* api_refs.yaml: checkout the right branch before forking a new one.

* api_refs.yaml: dummy triggers to register workflow

* Revert "api_refs.yaml: dummy triggers to register workflow"

This reverts commit 530cb71.

* api_refs.yaml: Fix base_branch parsing

* api_refs.yaml: Fix new branch creation

* api_refs.yaml: Set a Git user

Switched to a new branch 'api_refs_v4.6.x'
Author identity unknown

*** Please tell me who you are.

Run

  git config --global user.email "[email protected]"
  git config --global user.name "Your Name"

to set your account's default identity.
Omit --global to set the identity only in this repository.

* api_refs.yaml: Fix branch push

fatal: The current branch api_refs_v4.6.x has no upstream branch.
To push the current branch and set the remote as upstream, use
    git push --set-upstream origin api_refs_v4.6.x

* api_refs.yaml: Fix branch push

* api_refs.yaml: Fix branch push and PR create

* api_refs.yaml: Fix branch push and PR create

* api_refs.yaml: Composer authentication

* api_refs.yaml: Composer authentication

* api_refs.yaml: Enh. PHP performance

Disable xdebug

- https://github.com/actions/runner-images/blob/ubuntu24/20250504.1/images/ubuntu/Ubuntu2404-Readme.md#php-tools
- https://github.com/marketplace/actions/setup-php-action#xdebug
- https://github.com/marketplace/actions/setup-php-action#disable-coverage

* api_refs.yaml: Prepare PR state and labels

* api_refs.yaml: Try to debug the \E issue

* api_refs.yaml: Try to debug the \E issue

* api_refs.yaml: Try to debug the \E issue

* api_refs.yaml: Try to debug the \E issue

* api_refs.yaml: Try to fix the \E issue

* api_refs.yaml: Try to fix the \E issue

* Revert "api_refs.yaml: Try to fix the \E issue"

This reverts commit 16fd5be.

* api_refs.yaml: Try to fix the \E issue

* api_refs.yaml: Clean-up after debug

* api_refs.yaml: Try to trigger PR workflows

peter-evans/create-pull-request#48 (comment)

* api_refs.yaml: Try to trigger PR workflows

peter-evans/create-pull-request#48 (comment)

* api_refs.yaml: Try to trigger PR workflows

https://github.com/peter-evans/create-pull-request?tab=readme-ov-file#token

https://github.com/peter-evans/create-pull-request/blob/main/docs/concepts-guidelines.md#triggering-further-workflow-runs

* api_refs.yaml: Set prod conf back

Author: adriendupuis

.github/workflows/api_refs.yaml

@@ -0,0 +1,66 @@
+name: 'Build API Refs'
+
+on:
+    workflow_dispatch:
+        inputs:
+            version:
+                description: 'Released version'
+                required: true
+                type: string
+
+jobs:
+    open_php_api_ref_pr:
+        name: "PHP & REST API References' PR"
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Set version and branches
+              id: version_and_branches
+              run: |
+                  version="${{ inputs.version }}"
+                  base_branch="$(echo $version | sed 's/v\(.*\..*\)\..*/\1/')"
+                  work_branch="api_refs_$version"
+                  echo "version=$version" >> "$GITHUB_OUTPUT"
+                  echo "base_branch=$base_branch" >> "$GITHUB_OUTPUT"
+                  echo "work_branch=$work_branch" >> "$GITHUB_OUTPUT"
+
+            - name: Checkout documentation
+              uses: actions/checkout@v4
+              with:
+                  ref: ${{ steps.version_and_branches.outputs.base_branch }}
+
+            - name: Disable PHP coverage
+              uses: shivammathur/setup-php@v2
+              with:
+                  coverage: none
+
+            - name: Build API Refs
+              env:
+                  SATIS_NETWORK_KEY: ${{ secrets.SATIS_NETWORK_KEY }}
+                  SATIS_NETWORK_TOKEN: ${{ secrets.SATIS_NETWORK_TOKEN }}
+              run: |
+                  composer config --global http-basic.updates.ibexa.co $SATIS_NETWORK_KEY $SATIS_NETWORK_TOKEN
+                  #TODO: On 5.0, update tool to handle both PHP & REST APIs
+                  tools/php_api_ref/phpdoc.sh
+                  # Fix escape character:
+                  perl -pi -e 's/\e/\\E/g' tools/php_api_ref/.phpdoc/template/package-edition-map.twig
+
+            - name: Commit
+              run: |
+                  git config --global user.name "${GITHUB_ACTOR}"
+                  git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+                  git add docs/api/php_api/php_api_reference/ tools/php_api_ref/.phpdoc/template/package-edition-map.twig
+                  git commit -m "PHP API Ref HTML"
+                  #TODO: git add doc/api/rest_api/rest_api_reference/rest_api_reference.html
+                  #TODO: git commit -m "REST API Ref HTML"
+
+            - name: Create Pull Request
+              uses: peter-evans/create-pull-request@v7
+              with:
+                  token: ${{ secrets.EZROBOT_PAT }}
+                  title: "PHP API Ref ${{ steps.version_and_branches.outputs.version }}"
+                  body: "PHP API Reference update for ${{ steps.version_and_branches.outputs.version }}"
+                  branch: "${{ steps.version_and_branches.outputs.work_branch }}"
+                  base: "${{ steps.version_and_branches.outputs.base_branch }}"
+                  draft: false
+                  labels: 'Needs DOC review'