Skip to content

IBX-9737: Enhance PHP API Ref generation tool #2677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Parent: Update importing_assets_from_bundle.md
merged 3 commits into from
Mar 21, 2025
Merged

IBX-9737: Enhance PHP API Ref generation tool #2677

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eae9cee
edition-tag.html.twig: New line before package
adriendupuis Mar 21, 2025
b264fbb
phpdoc.sh: Ease the targeting of a dev branch
adriendupuis Mar 21, 2025
b56f896
Merge branch 'master' into enh-php-api-ref-tool
adriendupuis Mar 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tools/php_api_ref/.phpdoc/template/components/edition-tag.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@
{% endfor %}
{% endif %}
{% elseif package_edition_map[package] == 'optional' %}
<div class="pill optional-pill" title="Included in the optional package {{ package }}"></div>
<div class="pill optional-pill" title="Included in the optional package&#x000A;{{ package }}"></div>
{% endif %}
{% endblock %}
31 changes: 23 additions & 8 deletions tools/php_api_ref/phpdoc.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ PHPDOC_DIR="$(pwd)/tools/php_api_ref/.phpdoc"; # Absolute path to phpDocumentor
PHP_BINARY="php -d error_reporting=`php -r 'echo E_ALL & ~E_DEPRECATED;'`"; # Avoid depreciation messages from phpDocumentor/Reflection/issues/529 when using PHP 8.2 or higher
TMP_DXP_DIR=/tmp/ibexa-dxp-phpdoc; # Absolute path of the temporary directory in which Ibexa DXP will be installed and the PHP API Reference built
FORCE_DXP_INSTALL=1; # If 1, empty the temporary directory, install DXP from scratch, build, remove temporary directory; if 0, potentially reuse the DXP already installed in temporary directory, keep temporary directory for future uses.
BASE_DXP_BRANCH=''; # Branch from and for which the Reference is built when using a dev branch as version
VIRTUAL_DXP_VERSION=''; # Version for which the reference is supposedly built when using dev branch as version

if [ ! -d $OUTPUT_DIR ]; then
echo -n "Creating ${OUTPUT_DIR}… ";
Expand Down Expand Up @@ -49,9 +51,18 @@ cd $TMP_DXP_DIR; # /!\ Change working directory (reason why all paths must be ab

if [ 0 -eq $DXP_ALREADY_EXISTS ]; then
echo "Creating ibexa/$DXP_EDITION-skeleton:$DXP_VERSION project in ${TMP_DXP_DIR}…";
composer create-project ibexa/$DXP_EDITION-skeleton:$DXP_VERSION . --no-interaction --no-install --ignore-platform-reqs --no-scripts;
if [ -n "$AUTH_JSON" ]; then
cp $AUTH_JSON ./;
if [[ "$DXP_VERSION" == *".x-dev" ]]; then
composer create-project ibexa/website-skeleton:$DXP_VERSION . --no-interaction --no-install --ignore-platform-reqs --no-scripts --stability=dev;
if [ -n "$AUTH_JSON" ]; then
cp $AUTH_JSON ./;
fi;
composer config repositories.ibexa composer https://updates.ibexa.co;
composer require ibexa/$DXP_EDITION:$DXP_VERSION --no-interaction --update-with-all-dependencies --no-install --ignore-platform-reqs --no-scripts;
else
composer create-project ibexa/$DXP_EDITION-skeleton:$DXP_VERSION . --no-interaction --no-install --ignore-platform-reqs --no-scripts;
if [ -n "$AUTH_JSON" ]; then
cp $AUTH_JSON ./;
fi;
fi;
composer install --no-interaction --ignore-platform-reqs --no-scripts;
fi;
Expand All @@ -70,11 +81,11 @@ if [ 0 -eq $DXP_ALREADY_EXISTS ]; then
done;
fi;

#if [ 0 -eq $DXP_ALREADY_EXISTS ]; then
# MY_PACKAGE='';
# MY_BRANCH='';
# composer require --no-interaction --ignore-platform-reqs --no-scripts ibexa/$MY_PACKAGE "$MY_BRANCH as $DXP_VERSION";
#fi;
if [[ "$DXP_VERSION" == *".x-dev" ]]; then
GIT_REF=$BASE_DXP_BRANCH;
else
GIT_REF="v$DXP_VERSION";
fi

if [ 0 -eq $DXP_ALREADY_EXISTS ]; then
echo -n 'Building package→edition map… ';
Expand Down Expand Up @@ -117,6 +128,10 @@ if [ 0 -eq $DXP_ALREADY_EXISTS ]; then
echo 'OK';
fi;

if [[ "$DXP_VERSION" == *".x-dev" ]]; then
DXP_VERSION=$VIRTUAL_DXP_VERSION;
fi;

echo 'Set up phpDocumentor…';
sed "s/version number=\".*\"/version number=\"$DXP_VERSION\"/" $PHPDOC_CONF > ./phpdoc.dist.xml;
mkdir .phpdoc;
Expand Down