IBX-9904: Workflow to build API refs into new PR

[adriendupuis]

Question	Answer
JIRA Ticket	IBX-9904
Versions	5.0, 4.6
Edition	Commerce

Create a workflow that can be triggered to build

• PHP API Reference on 4.6 and 5.0
• REST API Reference on 5.0

On ibexa/commerce-skeletonhttps://github.com/ibexa/commerce-skeleton/blob/master/.github/workflows/ can then be added a workflow like the following:

name: 'PHP & REST API References'

on:
    push:
        tags:
            - 'v*'

jobs:
    trigger-api-refs-build:
        name: 'Build API references'
        runs-on: ubuntu-latest
        steps:
          - uses: octokit/[email protected]
            name: "Trigger API references' build"
            with:
                repository: ibexa/documentation-developer
                workflow: 'api_refs.yaml'
                ref: ${{ github.ref_name }}
                route: POST /repos/{repository}/actions/workflows/{workflow}/dispatches
                inputs: '{ "version": "${{ github.ref_name }}" }'
            env:
                GITHUB_TOKEN: ${{ secrets.TRAVIS_GITHUB_TOKEN }}

Checklist

• Text renders correctly
• Text has been checked with vale
• Description metadata is up to date
• Redirects cover removed/moved pages
• Code samples are working
• PHP code samples have been fixed with PHP CS fixer
• Added link to this PR in relevant JIRA ticket or code PR

[github-actions]

Preview of modified files: no change to preview.

[adriendupuis]

Not used to build the references, only to create the branch.

• The script could evolve to receive version as an argument instead of alway building for the latest version (Is there a need for building old references?).
• Or just rename the inputs being renamed to avoid ambiguity (my favorite).

Suggested change

	version:
	description: 'Released version'
	required: true
	type: string
	branch_suffix:
	description: "Used in branch name to open PR for the latest version's references"
	required: true
	type: string

[adriendupuis]

To do this, few lines can be added to the 5.0 version of phpdoc.sh:

$PHP_BINARY bin/console ibexa:openapi --yaml > openapi.yaml
redocly build-docs openapi.yaml --output $(realpath $OUTPUT_DIR/../../rest_api/rest_api_reference/rest_api_reference.html)

Anyway, the tool should be renamed and reworked to reflect its new task of building both references.