From efc2c1aa6b44d3d667f4ef3153961173ebebe2af Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Wed, 30 Apr 2025 09:33:02 +0200 Subject: [PATCH 01/28] Draft workflow to open API refs PR --- .github/workflows/api_refs.yaml | 54 +++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 .github/workflows/api_refs.yaml diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml new file mode 100644 index 0000000000..83acfa24d6 --- /dev/null +++ b/.github/workflows/api_refs.yaml @@ -0,0 +1,54 @@ +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 + + - name: Build API Refs + # TODO: On 5.0, update tool to handle both PHP & REST APIs + # TODO: Composer auth? + run: tools/php_api_ref/phpdoc.sh + + - name: Commit and push + run: | + git checkout ${{ steps.version_and_branches.outputs.work_branch }} + git add docs/api/php_api/php_api_reference/ tools/php_api_ref/.phpdoc/template/package-edition-map.twig + #TODO: Set a user? + 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" + #TODO: permission to push? Use an action? https://github.com/marketplace/actions/github-push + git push + + - name: Create Pull Request + uses: peter-evans/create-pull-request@v3 + with: + #TODO: token: ${{ ? }} + 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 From a41b6dab52db9f2acd3eee27d8dba6158bf4d602 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Tue, 6 May 2025 16:34:34 +0200 Subject: [PATCH 02/28] api_refs.yaml: checkout the right branch before forking a new one. --- .github/workflows/api_refs.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index 83acfa24d6..c7b41ddf37 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -26,6 +26,8 @@ jobs: - name: Checkout documentation uses: actions/checkout@v4 + with: + ref: ${{ steps.version_and_branches.outputs.base_branch }} - name: Build API Refs # TODO: On 5.0, update tool to handle both PHP & REST APIs From 530cb712396f7cc691586d5d44c08f26649a599f Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Wed, 7 May 2025 10:10:51 +0200 Subject: [PATCH 03/28] api_refs.yaml: dummy triggers to register workflow --- .github/workflows/api_refs.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index c7b41ddf37..5b5232d579 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -7,6 +7,8 @@ on: description: 'Released version' required: true type: string + push: + pull_request: jobs: open_php_api_ref_pr: From 351dd8664fe2d8b7cf5aec2fed722bba1fec6c99 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Wed, 7 May 2025 10:12:59 +0200 Subject: [PATCH 04/28] Revert "api_refs.yaml: dummy triggers to register workflow" This reverts commit 530cb712396f7cc691586d5d44c08f26649a599f. --- .github/workflows/api_refs.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index 5b5232d579..c7b41ddf37 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -7,8 +7,6 @@ on: description: 'Released version' required: true type: string - push: - pull_request: jobs: open_php_api_ref_pr: From d35164c945b9190ecd346a0b0f8287ca42a35f89 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Wed, 7 May 2025 10:18:14 +0200 Subject: [PATCH 05/28] api_refs.yaml: Fix base_branch parsing --- .github/workflows/api_refs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index c7b41ddf37..68fa6808e8 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -18,7 +18,7 @@ jobs: id: version_and_branches run: | version="${{ inputs.version }}" - base_branch="$(echo $version | sed -s /v(.*\..*)\..*/\1/)" + 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" From 860852692b75d9fd6a318772e208a175df60ae48 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Wed, 7 May 2025 10:25:58 +0200 Subject: [PATCH 06/28] api_refs.yaml: Fix new branch creation --- .github/workflows/api_refs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index 68fa6808e8..21cd67f6bc 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -36,7 +36,7 @@ jobs: - name: Commit and push run: | - git checkout ${{ steps.version_and_branches.outputs.work_branch }} + git checkout -b ${{ steps.version_and_branches.outputs.work_branch }} git add docs/api/php_api/php_api_reference/ tools/php_api_ref/.phpdoc/template/package-edition-map.twig #TODO: Set a user? git commit -m "PHP API Ref HTML" From 35837180e24700a97d2828bb23064de2f0f7816d Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Wed, 7 May 2025 10:42:00 +0200 Subject: [PATCH 07/28] 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 "you@example.com" git config --global user.name "Your Name" to set your account's default identity. Omit --global to set the identity only in this repository. --- .github/workflows/api_refs.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index 21cd67f6bc..110c39baa8 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -36,9 +36,10 @@ jobs: - name: Commit and push run: | + git config --global user.name "${GITHUB_ACTOR}" + git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com" git checkout -b ${{ steps.version_and_branches.outputs.work_branch }} git add docs/api/php_api/php_api_reference/ tools/php_api_ref/.phpdoc/template/package-edition-map.twig - #TODO: Set a user? 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" From 2877a5f9aea2d4af52560513f2c8a50d0926521e Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Wed, 7 May 2025 10:58:08 +0200 Subject: [PATCH 08/28] 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 --- .github/workflows/api_refs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index 110c39baa8..a9b8671d81 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -44,7 +44,7 @@ jobs: #TODO: git add doc/api/rest_api/rest_api_reference/rest_api_reference.html #TODO: git commit -m "REST API Ref HTML" #TODO: permission to push? Use an action? https://github.com/marketplace/actions/github-push - git push + git push --set-upstream origin api_refs_v4.6.x - name: Create Pull Request uses: peter-evans/create-pull-request@v3 From 212c761c1a9f479b7fc7c3c9230640e804e32db9 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Wed, 7 May 2025 11:29:43 +0200 Subject: [PATCH 09/28] api_refs.yaml: Fix branch push --- .github/workflows/api_refs.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index a9b8671d81..ed017bf7af 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -39,12 +39,13 @@ jobs: git config --global user.name "${GITHUB_ACTOR}" git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com" git checkout -b ${{ steps.version_and_branches.outputs.work_branch }} + git push --set-upstream origin ${{ steps.version_and_branches.outputs.work_branch }} 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" - #TODO: permission to push? Use an action? https://github.com/marketplace/actions/github-push - git push --set-upstream origin api_refs_v4.6.x + #TODO: permission to push? Use an action? https://github.com/marketplace/actions/github-push + git push - name: Create Pull Request uses: peter-evans/create-pull-request@v3 From 07dbfe09c78ce9fe1482034b20bb513ce8cd3c21 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Wed, 7 May 2025 12:18:53 +0200 Subject: [PATCH 10/28] api_refs.yaml: Fix branch push and PR create --- .github/workflows/api_refs.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index ed017bf7af..3b0b4f3cf6 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -39,16 +39,16 @@ jobs: git config --global user.name "${GITHUB_ACTOR}" git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com" git checkout -b ${{ steps.version_and_branches.outputs.work_branch }} - git push --set-upstream origin ${{ steps.version_and_branches.outputs.work_branch }} + #git push --set-upstream origin ${{ steps.version_and_branches.outputs.work_branch }} 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" #TODO: permission to push? Use an action? https://github.com/marketplace/actions/github-push - git push + #git push - name: Create Pull Request - uses: peter-evans/create-pull-request@v3 + uses: peter-evans/create-pull-request@v7 with: #TODO: token: ${{ ? }} title: "PHP API Ref ${{ steps.version_and_branches.outputs.version }}" From 966229f7c72866e50441e2b75e4319d825e4534b Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Wed, 7 May 2025 12:21:59 +0200 Subject: [PATCH 11/28] api_refs.yaml: Fix branch push and PR create --- .github/workflows/api_refs.yaml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index 3b0b4f3cf6..0544a1ab3c 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -34,18 +34,15 @@ jobs: # TODO: Composer auth? run: tools/php_api_ref/phpdoc.sh - - name: Commit and push + - name: Commit run: | git config --global user.name "${GITHUB_ACTOR}" git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com" - git checkout -b ${{ steps.version_and_branches.outputs.work_branch }} - #git push --set-upstream origin ${{ steps.version_and_branches.outputs.work_branch }} 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" #TODO: permission to push? Use an action? https://github.com/marketplace/actions/github-push - #git push - name: Create Pull Request uses: peter-evans/create-pull-request@v7 From 339e28b6e306a77c6a49dbe46303e3b151071000 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Wed, 7 May 2025 13:02:40 +0200 Subject: [PATCH 12/28] api_refs.yaml: Composer authentication --- .github/workflows/api_refs.yaml | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index 0544a1ab3c..b8285baba0 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -30,9 +30,13 @@ jobs: ref: ${{ steps.version_and_branches.outputs.base_branch }} - name: Build API Refs - # TODO: On 5.0, update tool to handle both PHP & REST APIs - # TODO: Composer auth? - run: tools/php_api_ref/phpdoc.sh + env: + SATIS_NETWORK_KEY: ${{ secrets.SATIS_NETWORK_KEY }} + SATIS_NETWORK_TOKEN: ${{ secrets.SATIS_NETWORK_TOKEN }} + run: | + composer config 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 - name: Commit run: | From a5ebbf9e2ac63671a6132ee8acfa29653b107e61 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Wed, 7 May 2025 13:17:34 +0200 Subject: [PATCH 13/28] api_refs.yaml: Composer authentication --- .github/workflows/api_refs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index b8285baba0..bc26f5bd4f 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -34,7 +34,7 @@ jobs: SATIS_NETWORK_KEY: ${{ secrets.SATIS_NETWORK_KEY }} SATIS_NETWORK_TOKEN: ${{ secrets.SATIS_NETWORK_TOKEN }} run: | - composer config http-basic.updates.ibexa.co $SATIS_NETWORK_KEY $SATIS_NETWORK_TOKEN + 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 From a05d429d7020d579d07bad1f939e631a04fe5965 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Wed, 7 May 2025 15:14:25 +0200 Subject: [PATCH 14/28] 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 --- .github/workflows/api_refs.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index bc26f5bd4f..12b75c0682 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -29,6 +29,11 @@ jobs: 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 }} From 042e1b5d01c69028b9c536bf0eeba3210e4d1eb0 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Wed, 7 May 2025 17:02:16 +0200 Subject: [PATCH 15/28] api_refs.yaml: Prepare PR state and labels --- .github/workflows/api_refs.yaml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index 12b75c0682..5549ad3e8d 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -61,4 +61,7 @@ jobs: 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 + draft: true + #TODO: draft: false + labels: Invalid + #TODO: labels: Needs DOC review From 2338db626c4b227f02f0531edc1f35b62394da73 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 12 May 2025 09:26:14 +0200 Subject: [PATCH 16/28] api_refs.yaml: Try to debug the \E issue --- .github/workflows/api_refs.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index 5549ad3e8d..04196ac4e4 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -42,6 +42,8 @@ jobs: 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 + #DEBUG + cat tools/php_api_ref/.phpdoc/template/package-edition-map.twig - name: Commit run: | @@ -49,6 +51,8 @@ jobs: 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" + #DEBUG + cat tools/php_api_ref/.phpdoc/template/package-edition-map.twig #TODO: git add doc/api/rest_api/rest_api_reference/rest_api_reference.html #TODO: git commit -m "REST API Ref HTML" #TODO: permission to push? Use an action? https://github.com/marketplace/actions/github-push From 4ad53d2cbe3257eb968855228c34fd65295609a5 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 12 May 2025 09:30:12 +0200 Subject: [PATCH 17/28] api_refs.yaml: Try to debug the \E issue --- .github/workflows/api_refs.yaml | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index 04196ac4e4..43ee33d4ac 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -57,15 +57,15 @@ jobs: #TODO: git commit -m "REST API Ref HTML" #TODO: permission to push? Use an action? https://github.com/marketplace/actions/github-push - - name: Create Pull Request - uses: peter-evans/create-pull-request@v7 - with: - #TODO: token: ${{ ? }} - 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: true - #TODO: draft: false - labels: Invalid - #TODO: labels: Needs DOC review +# - name: Create Pull Request +# uses: peter-evans/create-pull-request@v7 +# with: +# #TODO: token: ${{ ? }} +# 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: true +# #TODO: draft: false +# labels: Invalid +# #TODO: labels: Needs DOC review From de4a959646723a2ea46dc417a6884eae029c14e3 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 12 May 2025 10:52:58 +0200 Subject: [PATCH 18/28] api_refs.yaml: Try to debug the \E issue --- .github/workflows/api_refs.yaml | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index 43ee33d4ac..ef970ade22 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -43,6 +43,14 @@ jobs: #TODO: On 5.0, update tool to handle both PHP & REST APIs tools/php_api_ref/phpdoc.sh #DEBUG + echo '--' + echo '\E' + echo "\E" + echo '\E' > tmp.txt + echo "\E" >> tmp.txt + cat tmp.txt + echo '==' + rm tmp.txt cat tools/php_api_ref/.phpdoc/template/package-edition-map.twig - name: Commit @@ -51,8 +59,6 @@ jobs: 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" - #DEBUG - cat tools/php_api_ref/.phpdoc/template/package-edition-map.twig #TODO: git add doc/api/rest_api/rest_api_reference/rest_api_reference.html #TODO: git commit -m "REST API Ref HTML" #TODO: permission to push? Use an action? https://github.com/marketplace/actions/github-push From 0f262ab2286fc046d79766a7e2bac69e4c5805d0 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 12 May 2025 11:59:58 +0200 Subject: [PATCH 19/28] api_refs.yaml: Try to debug the \E issue --- .github/workflows/api_refs.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index ef970ade22..574a091bf1 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -41,13 +41,13 @@ jobs: 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 + bash tools/php_api_ref/phpdoc.sh #DEBUG echo '--' - echo '\E' - echo "\E" - echo '\E' > tmp.txt - echo "\E" >> tmp.txt + echo '\\E' + echo "\\E" + echo '\\E' > tmp.txt + echo "\\E" >> tmp.txt cat tmp.txt echo '==' rm tmp.txt From 312b68c838d3977c323260899b52abfb4a7fd220 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 12 May 2025 13:14:01 +0200 Subject: [PATCH 20/28] api_refs.yaml: Try to fix the \E issue --- .github/workflows/api_refs.yaml | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index 574a091bf1..5a122b9b42 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -41,16 +41,9 @@ jobs: 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 - bash tools/php_api_ref/phpdoc.sh - #DEBUG - echo '--' - echo '\\E' - echo "\\E" - echo '\\E' > tmp.txt - echo "\\E" >> tmp.txt - cat tmp.txt - echo '==' - rm tmp.txt + tools/php_api_ref/phpdoc.sh + cat tools/php_api_ref/.phpdoc/template/package-edition-map.twig + sed -i 's//\\\E/' tools/php_api_ref/.phpdoc/template/package-edition-map.twig cat tools/php_api_ref/.phpdoc/template/package-edition-map.twig - name: Commit From 16fd5beace475a9c8ddaebcf511d576fa1766a38 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 12 May 2025 13:32:21 +0200 Subject: [PATCH 21/28] api_refs.yaml: Try to fix the \E issue --- .github/workflows/api_refs.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index 5a122b9b42..a7098e4693 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -43,8 +43,6 @@ jobs: #TODO: On 5.0, update tool to handle both PHP & REST APIs tools/php_api_ref/phpdoc.sh cat tools/php_api_ref/.phpdoc/template/package-edition-map.twig - sed -i 's//\\\E/' tools/php_api_ref/.phpdoc/template/package-edition-map.twig - cat tools/php_api_ref/.phpdoc/template/package-edition-map.twig - name: Commit run: | From dd4d8b933e7847c0b611daa33a7eb8174b3e5231 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 12 May 2025 13:43:18 +0200 Subject: [PATCH 22/28] Revert "api_refs.yaml: Try to fix the \E issue" This reverts commit 16fd5beace475a9c8ddaebcf511d576fa1766a38. --- .github/workflows/api_refs.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index a7098e4693..5a122b9b42 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -43,6 +43,8 @@ jobs: #TODO: On 5.0, update tool to handle both PHP & REST APIs tools/php_api_ref/phpdoc.sh cat tools/php_api_ref/.phpdoc/template/package-edition-map.twig + sed -i 's//\\\E/' tools/php_api_ref/.phpdoc/template/package-edition-map.twig + cat tools/php_api_ref/.phpdoc/template/package-edition-map.twig - name: Commit run: | From d4611c3f7d8b7fe27a458f0f3195361142738066 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 12 May 2025 13:43:36 +0200 Subject: [PATCH 23/28] api_refs.yaml: Try to fix the \E issue --- .github/workflows/api_refs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index 5a122b9b42..fd1e696f7d 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -43,7 +43,7 @@ jobs: #TODO: On 5.0, update tool to handle both PHP & REST APIs tools/php_api_ref/phpdoc.sh cat tools/php_api_ref/.phpdoc/template/package-edition-map.twig - sed -i 's//\\\E/' tools/php_api_ref/.phpdoc/template/package-edition-map.twig + perl -pi -e 's/\e/\\E/g' tools/php_api_ref/.phpdoc/template/package-edition-map.twig cat tools/php_api_ref/.phpdoc/template/package-edition-map.twig - name: Commit From 6595e79166788a44c9f016cb906895a086978488 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 12 May 2025 14:12:25 +0200 Subject: [PATCH 24/28] api_refs.yaml: Clean-up after debug --- .github/workflows/api_refs.yaml | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index fd1e696f7d..467bb2a97f 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -42,9 +42,8 @@ jobs: 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 - cat tools/php_api_ref/.phpdoc/template/package-edition-map.twig + # Fix escape character: perl -pi -e 's/\e/\\E/g' tools/php_api_ref/.phpdoc/template/package-edition-map.twig - cat tools/php_api_ref/.phpdoc/template/package-edition-map.twig - name: Commit run: | @@ -56,15 +55,14 @@ jobs: #TODO: git commit -m "REST API Ref HTML" #TODO: permission to push? Use an action? https://github.com/marketplace/actions/github-push -# - name: Create Pull Request -# uses: peter-evans/create-pull-request@v7 -# with: -# #TODO: token: ${{ ? }} -# 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: true -# #TODO: draft: false -# labels: Invalid -# #TODO: labels: Needs DOC review + - name: Create Pull Request + uses: peter-evans/create-pull-request@v7 + with: + 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: true + #TODO: draft: false + labels: Invalid + #TODO: labels: Needs DOC review From bfb1f44ea02a197f12aa1d0e15ca2ba93cc588bd Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 12 May 2025 15:36:52 +0200 Subject: [PATCH 25/28] api_refs.yaml: Try to trigger PR workflows https://github.com/peter-evans/create-pull-request/issues/48#issuecomment-536204092 --- .github/workflows/api_refs.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index 467bb2a97f..cdf89e46cd 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -57,6 +57,8 @@ jobs: - name: Create Pull Request uses: peter-evans/create-pull-request@v7 + env: + GITHUB_TOKEN: ${{ secrets.TRAVIS_GITHUB_TOKEN }} with: title: "PHP API Ref ${{ steps.version_and_branches.outputs.version }}" body: "PHP API Reference update for ${{ steps.version_and_branches.outputs.version }}" From 7dc879467ace172be6e69ebe748e60b20a4d5c69 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Mon, 12 May 2025 18:14:38 +0200 Subject: [PATCH 26/28] api_refs.yaml: Try to trigger PR workflows https://github.com/peter-evans/create-pull-request/issues/48#issuecomment-536204092 --- .github/workflows/api_refs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index cdf89e46cd..27846a773a 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -58,7 +58,7 @@ jobs: - name: Create Pull Request uses: peter-evans/create-pull-request@v7 env: - GITHUB_TOKEN: ${{ secrets.TRAVIS_GITHUB_TOKEN }} + GITHUB_TOKEN: ${{ secrets.EZROBOT_PAT }} with: title: "PHP API Ref ${{ steps.version_and_branches.outputs.version }}" body: "PHP API Reference update for ${{ steps.version_and_branches.outputs.version }}" From 946d0e3e553fb1972493f642de233200fef19ed5 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Tue, 13 May 2025 08:49:13 +0200 Subject: [PATCH 27/28] 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 --- .github/workflows/api_refs.yaml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index 27846a773a..e8d07a2bdc 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -57,9 +57,8 @@ jobs: - name: Create Pull Request uses: peter-evans/create-pull-request@v7 - env: - GITHUB_TOKEN: ${{ secrets.EZROBOT_PAT }} 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 }}" From dabdfa9c4269ccacb560cdd91a7e21a5a2e383d1 Mon Sep 17 00:00:00 2001 From: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> Date: Tue, 13 May 2025 09:36:21 +0200 Subject: [PATCH 28/28] api_refs.yaml: Set prod conf back --- .github/workflows/api_refs.yaml | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/.github/workflows/api_refs.yaml b/.github/workflows/api_refs.yaml index e8d07a2bdc..424f816818 100644 --- a/.github/workflows/api_refs.yaml +++ b/.github/workflows/api_refs.yaml @@ -53,7 +53,6 @@ jobs: 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" - #TODO: permission to push? Use an action? https://github.com/marketplace/actions/github-push - name: Create Pull Request uses: peter-evans/create-pull-request@v7 @@ -63,7 +62,5 @@ jobs: 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: true - #TODO: draft: false - labels: Invalid - #TODO: labels: Needs DOC review + draft: false + labels: 'Needs DOC review'