5.0: Build REST API Ref W/ PHP API Ref

.github/workflows/api_refs.yaml

@@ -20,6 +20,11 @@ jobs:
                   version="${{ inputs.version }}"
                   base_branch="$(echo $version | sed 's/v\(.*\..*\)\..*/\1/')"
                   work_branch="api_refs_$version"
+                  #TMP
+                  if [[ '5.0' == $base_branch ]]; then
+                    base_branch='5.0-api-refs'
+                  fi
+                  #/TMP
                   echo "version=$version" >> "$GITHUB_OUTPUT"
                   echo "base_branch=$base_branch" >> "$GITHUB_OUTPUT"
                   echo "work_branch=$work_branch" >> "$GITHUB_OUTPUT"
@@ -34,32 +39,52 @@ jobs:
               with:
                   coverage: none
 
+            - name: Set up node
+              uses: actions/setup-node@v4
+            - name: Install Redocly CLI
+              run: npm install -g @redocly/cli@latest
+
             - name: Build API Refs
               env:
                   SATIS_NETWORK_KEY: ${{ secrets.SATIS_NETWORK_KEY }}
                   SATIS_NETWORK_TOKEN: ${{ secrets.SATIS_NETWORK_TOKEN }}
+                  BASE_BRANCH: ${{ steps.version_and_branches.outputs.base_branch }}
               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
+                  if [[ '4.6' != $BASE_BRANCH ]]; then
+                    tools/api_refs/api_refs.sh
+                    # Fix escape character:
+                    perl -pi -e 's/\e/\\E/g' tools/api_refs/.phpdoc/template/package-edition-map.twig
+                  else
+                    tools/php_api_ref/phpdoc.sh
+                    # Fix escape character:
+                    perl -pi -e 's/\e/\\E/g' tools/api_refs/php_api_ref/template/package-edition-map.twig
+                    cd tools/raml2html/; composer install; cd -;
+                    php tools/raml2html/raml2html.php build --non-standard-http-methods=COPY,MOVE,PUBLISH,SWAP -t default -o docs/api/rest_api/rest_api_reference/ docs/api/rest_api/rest_api_reference/input/ibexa.raml
+                  fi
 
             - name: Commit
+              env:
+                  BASE_BRANCH: ${{ steps.version_and_branches.outputs.base_branch }}
               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"
+                  git add docs/api/php_api/php_api_reference/
+                  if [[ '4.6' != $BASE_BRANCH ]]; then
+                    git add tools/api_refs/.phpdoc/template/package-edition-map.twig
+                  else
+                    git add tools/php_api_ref/.phpdoc/template/package-edition-map.twig
+                  fi
+                  git diff-index --quiet --cached HEAD || git commit -m "PHP API Ref HTML"
+                  git add docs/api/rest_api/rest_api_reference/rest_api_reference.html
+                  git diff-index --quiet --cached HEAD || 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 }}"
+                  title: "API Refs ${{ steps.version_and_branches.outputs.version }}"
+                  body: "PHP API & REST API References 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