Allowed building dev version of the API references from Github Actions#3173
Merged
Conversation
|
Preview of modified files: no change to preview. |
9d7d312 to
42e2b86
Compare
Contributor
adriendupuis
left a comment
There was a problem hiding this comment.
Good code.
I would have passed them as command line arguments or options but this can be difficult. And there is a good workaround to pass temporary env vars to a command.
Contributor
There was a problem hiding this comment.
I would document this in tools/api_refs/README.md
I guess I can now run locally something like:
DXP_VERSION=v5.0.x-dev BASE_DXP_BRANCH=5.0 VIRTUAL_DXP_VERSION=5.0.10 tools/api_refs/api_refs.sh ~/my/path/to/auth.json54b2aa7 to
9329392
Compare
df91567 to
2339246
Compare
adriendupuis
approved these changes
May 20, 2026
Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com>
2339246 to
03a37c6
Compare
|
❌ The last analysis has failed. |
mnocon
added a commit
that referenced
this pull request
May 20, 2026
#3173) * Allowed building dev version of the API references from Github Actions * Added GitHub token to the workflow * Added Readme * Update .github/workflows/api_refs.yaml Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com> * Apply suggestion from @adriendupuis --------- Co-authored-by: Adrien Dupuis <61695653+adriendupuis@users.noreply.github.com>
7 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The goal is to be able generate the PHP API reference from the dev version as soon as the code freeze is announced, so that we can merge this to the release notes PRs and add the missing links.
Contains TMP commit: 42e2b86 that must be removed before merging
Two tests:
https://github.com/ibexa/documentation-developer/actions/runs/25371338588/job/74395337962
Result:
Branch 'api_refs_v5.0.9' is not ahead of base '5.0' and will not be createdSo the result is the same - the script was run with:
Build: https://github.com/ibexa/documentation-developer/actions/runs/25921140306/job/76190184119
Result: #3204