IBX-9904: Workflow to build API refs into new PR #2723
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Preview of modified files: no change to preview. |
adriendupuis
commented
Apr 30, 2025
adriendupuis
changed the title
adriendupuis
commented
Apr 30, 2025
.github/workflows/api_refs.yaml
Outdated
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Build API Refs | ||
| # TODO: On 5.0, update tool to handle both PHP & REST APIs |
There was a problem hiding this comment.
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.
This reverts commit 530cb71.
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.
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
Closed
Closed
This reverts commit 16fd5be.
Closed
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Create a workflow that can be triggered to build
Will be triggered when a Commerce release is tagged: ibexa/commerce-skeleton#5
Tested with manual triggering
gh workflow run api_refs.yaml --ref api-refs-workflow -f version='v4.6.x'Successfully created PR: #2740
Uses peter-evans/create-pull-request
TODO: In another PR, make the API builder 5.0/REST ready and edit the workflow to commit the REST API Ref as well.
Checklist