ACM-45114 Add version override to the generate-doc-links.py script

[fxiang1]

📝 Summary

Ticket Summary (Title):
Add version override to the generate-doc-links.py script

Ticket Link:
https://redhat.atlassian.net/browse/ACM-45114

Type of Change:

• 🐞 Bug Fix
• ✨ Feature
• 🔧 Refactor
• 💸 Tech Debt
• 🧪 Test-related
• 📄 Docs

---

✅ Checklist

General

• PR title follows the convention (e.g. ACM-12340 Fix bug with...)
• Code builds and runs locally without errors
• No console logs, commented-out code, or unnecessary files
• All commits are meaningful and well-labeled
• All new display strings are externalized for localization (English only)
• (Nice to have) JSDoc comments added for new functions and interfaces

If Feature

• UI/UX reviewed (if applicable)
• All acceptance criteria met
• Unit test coverage added or updated
• Relevant documentation or comments included

If Bugfix

• Root cause and fix summary are documented in the ticket (for future reference / errata)
• Fix tested thoroughly and resolves the issue
• Test(s) added to prevent regression

---

🗒️ Notes for Reviewers

Added two new options for the script in the event of a product version jump ie. 2.17 -> 5.0:

• one for setting the old ACM version
• one for setting the old OCP version

./generate-doc-links.py [--compare] [--previous-acm-version VERSION] [--previous-ocp-version VERSION]

Example:

./generate-doc-links.py --previous-acm-version 2.17 --previous-ocp-version 4.22

Setting these options will override the previous doc version, the script will no longer calculate the previous doc version from the current version.

Summary by CodeRabbit

• New Features
  • Added command-line options to specify previous ACM and OCP documentation versions when generating documentation links.
  • Updated usage guidance to describe the new version override options.

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fxiang1

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [fxiang1]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: fd51b4bd-7d64-44b3-96cd-e7764e6057c5

📥 Commits

Reviewing files that changed from the base of the PR and between 44113d3 and 6db2373.

📒 Files selected for processing (1)

• generate-doc-links.py

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

Changes

Documentation Version Overrides

Layer / File(s)	Summary
CLI version selection generate-doc-links.py	The script documents and parses --old-version and --old-ocp-version. Provided values override version decrementing. Without overrides, the existing fallback remains active.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 6db23

The version override change is bounded to documented CLI options and version selection, with no unresolved merge-blocking risk identified.

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files.	Write docstrings for the functions missing them to satisfy the coverage threshold.
Description check	⚠️ Warning	The description includes the ticket summary, ticket link, review notes, command usage, and behavior details. However, no change type is selected, and all checklist items remain unchecked, so completio…	Select the applicable change type and update the checklist with confirmed results. Document build or runtime verification and test coverage, or state clearly when an item does not apply.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Title check	✅ Passed	The title clearly identifies the ticket and the primary change: adding version override options to generate-doc-links.py.

Full details: Description check

Explanation

The description includes the ticket summary, ticket link, review notes, command usage, and behavior details. However, no change type is selected, and all checklist items remain unchecked, so completion of the required validation is not documented.

• Fix all pre-merge checks with AI

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

_{Comment @coderabbitai help to get the list of available commands.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud