[WIP] Adding a build-changed-pages.py script

[pneedle-rh]

This PR is a work in progress. Do not merge.

This applies to main, enterprise-4.11, enterprise-4.10, enterprise-4.9, enterprise-4.8, enterprise-4.7 and enterprise-4.6.

This PR adds a ./build-changed-pages.py script to the top level directory in the openshift-docs repo. You can run the script to build AsciiBinder previews only for openshift-docs pages that are changed in the latest commit in the branch.

The development is primarily intended for potential use with the Travis checks for the openshift-docs repo. This script can also be run manually in a local clone feature branch.

See the header of the script for details on how to run it.

[pneedle-rh]

@kalexand-rh hi! Can you please review this PR? Thanks!

[pneedle-rh]

After a bit of testing, it looks like the current approach in this script might only be useful for commits that change a few pages. This is because AsciiBinder only seems to allow you to specify the --pages or -p option once per build. Given this, the script currently runs asciibinder build -p <page> for each individual page that is changed in a commit. Having to run the command multiple times causes a performance overhead as you scale the number of changed pages in a commit.

I can't see a way to specify more than one page in a single AsciiBinder build run. For example:

• Asciibinder does not seem to accept a comma-separated list of pages with the -p option (unless I have the wrong format):

$ asciibinder build -p monitoring/monitoring-overview,monitoring/managing-alerts
Rebuilding 'monitoring/monitoring-overview,monitoring/managing-alerts/' on branch 'build-check-test'.
WARN: The /tmp/_topic_map.yml20220730-5158-q13k7f file on branch 'build-check-test' references 83 nonexistent topics. Set logging to 'debug' for details.

$ ls _preview/openshift-enterprise/build-check-test/monitoring/
$ 

• AsciiBinder does not allow you to specify the -p option more than once:

$ asciibinder build -p monitoring/monitoring-overview -p monitoring/managing-alerts
Error: option '-p' specified multiple times.
Try --help for help.

I haven't yet been able to find any detailed AsciiBinder documentation or help items on the option. I am continuing to review if there is a way to build more than one page in a single AsciiBinder build run.

If we can't find a way to build multiple selected pages in a single run, we could potentially explore the following if condition:

• If a commit changes less than a certain number of pages, then build only the changed pages
• Else if a commit changes more than a certain number of pages, then do a full build

[pneedle-rh]

This relates to #48653.

[pneedle-rh]

I created this RFE issue in AsciiBinder in relation to this.

[aireilly]

Could these processes be threaded in parallel? https://stackoverflow.com/a/14533902/7010427 This would solve your bottle neck. Right now, you are running builds sequentially.

[openshift-bot]

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

[openshift-bot]

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

[openshift-bot]

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

[openshift-ci]

@openshift-bot: Closed this PR.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

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/test-infra repository.