OSDOCS 13186 modify build_for_portal.py to detect images and not duplicate the entire image directory for every book #87375

mramendi · 2025-01-21T21:49:15Z

For https://issues.redhat.com/browse/OSDOCS-13186

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16, 4.17, 4.18

Issue:

OSDOCS 13186

Link to docs preview:

N/A

QE review:
N/A

Additional information:

This is a modification to the build_for_portal.py script, not to the documentation

ocpdocs-previewbot · 2025-01-21T22:16:30Z

🤖 Wed Jan 22 13:46:12 - Prow CI generated the docs preview:

https://87375--ocpdocs-pr.netlify.app/

gaurav-nelson · 2025-01-22T02:58:33Z

This is a significant improvement.
It brought down the size of the drupal-build dir from 3.5G to 106M. I also noticed faster processing of the script as well. Amazing work.

aireilly

Really great work, this is going to be a great optimzation! 🥳

Added some nit comments but also a question regarding the imagefiles array that I think needs to be addressed.

aireilly · 2025-01-22T09:26:31Z

build_for_portal.py

+        # ADDED 21 Jan 2025: selective processing of images
+        # the set of file names is to be stored in imagefiles
+        # The initial value includes images defined in attributes (to copy every time)
+        imagefiles = {"kebab.png","app-launcher.png","red-hat-applications-menu-icon.jpg","delete.png"}


Why are we hard coding these values, and is there a risk that we miss new additions going forward? Also, are these uniform across all branches? Maybe we need to scan the attributes folder for images.

I have reviewed the logic more carefully and realized that the prepopulation is unnecessary as the attributes file is scanned as part of looping through the includes. Regression testing showed that if I removed the prepopulation, the only difference was the disappearance of these four images from the API books, which otherwise have no images at all; a build-test of these books using asciidoctor-pdf shows that no issues are caused by removing these images.

build_for_portal.py

aireilly · 2025-01-22T09:45:49Z

Yes this is going to significantly speed up Prow too.

Local testing, got these results:

Current script:

real	**2m27.283s**
user	0m0.787s
sys	0m2.232s

Updated script:

real	**1m23.474s**
user	0m0.673s
sys	0m2.960s

…icate the entire image directory for every book

aireilly · 2025-01-22T13:33:07Z

/lgtm great work. Will merge and CP as you see fit.

openshift-ci · 2025-01-22T13:49:44Z

@mramendi: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

aireilly · 2025-01-23T09:56:10Z

Some older changes need to be CPd. Working on those now.

aireilly · 2025-01-23T11:07:18Z

/cherry-pick enterprise-4.12

aireilly · 2025-01-23T11:07:27Z

/cherry-pick enterprise-4.13

aireilly · 2025-01-23T11:07:33Z

/cherry-pick enterprise-4.14

aireilly · 2025-01-23T11:07:40Z

/cherry-pick enterprise-4.15

aireilly · 2025-01-23T11:07:46Z

/cherry-pick enterprise-4.16

aireilly · 2025-01-23T11:07:51Z

/cherry-pick enterprise-4.17

aireilly · 2025-01-23T11:07:54Z

/cherry-pick enterprise-4.18

openshift-cherrypick-robot · 2025-01-23T11:08:06Z

@aireilly: #87375 failed to apply on top of branch "enterprise-4.12":

Applying: OSDOCS 13186 modify build_for_portal.py to detect images and not duplicate the entire image directory for every book
Using index info to reconstruct a base tree...
M	build_for_portal.py
Falling back to patching base and 3-way merge...
Auto-merging build_for_portal.py
CONFLICT (content): Merge conflict in build_for_portal.py
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 OSDOCS 13186 modify build_for_portal.py to detect images and not duplicate the entire image directory for every book

In response to this:

/cherry-pick enterprise-4.12