Drop duplicated documentation links in GitHub Actions workflow template

[coderabbitai]

Description

The GitHub Actions workflow template file .github/workflows/build-notebooks-TEMPLATE.yaml contains duplicated documentation links at lines 109-110 that already exist at lines 8-9.

Issue Details

Lines 109-110 contain:

        # https://docs.github.com/en/actions/reference/variables-reference#default-environment-variables
        # https://docs.github.com/en/actions/how-tos/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables

These same links already appear at lines 8-9, making the duplication unnecessary and adding noise to the file.

Proposed Solution

Replace the duplicated links with a reference to the existing ones:

-        # https://docs.github.com/en/actions/reference/variables-reference#default-environment-variables
-        # https://docs.github.com/en/actions/how-tos/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables
+        # (see lines 8-9 for variable / context docs)

Branches to Fix

This cleanup should be applied to both:

• main branch
• 2024b branch

References

• Original PR: [2024b] RHOAIENG-28774: update the 2024b GitHub Action so that it does not end up pulling the wrong cache #1503
• Comment: [2024b] RHOAIENG-28774: update the 2024b GitHub Action so that it does not end up pulling the wrong cache #1503 (comment)

[jiridanek]

@coderabbitai implement and send PR with fix

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Fetch issue details from GitHub API
curl -s https://api.github.com/repos/opendatahub-io/notebooks/issues/1504 | jq '.title, .body'

Length of output: 1477

---

🏁 Script executed:

#!/bin/bash
curl -s https://raw.githubusercontent.com/opendatahub-io/notebooks/main/.github/workflows/build-notebooks-TEMPLATE.yaml | nl -ba | sed -n '1,140p'

Length of output: 239

---

🏁 Script executed:

#!/bin/bash
# Fetch the file and show with line numbers
curl -s https://raw.githubusercontent.com/opendatahub-io/notebooks/main/.github/workflows/build-notebooks-TEMPLATE.yaml | cat -n | head -140

Length of output: 7036

---

🏁 Script executed:

#!/bin/bash
curl -s https://raw.githubusercontent.com/opendatahub-io/notebooks/main/.github/workflows/build-notebooks-TEMPLATE.yaml | grep -n "variables-reference"

Length of output: 260

---

🏁 Script executed:

#!/bin/bash
curl -s https://raw.githubusercontent.com/opendatahub-io/notebooks/main/.github/workflows/build-notebooks-TEMPLATE.yaml | sed -n '170,180p' | cat -n

Length of output: 761

---

@jiridanek Here’s the patch plan for the duplicated-link cleanup; once applied it can be pushed as two small PRs (main + 2024b).

• Remove the redundant docs links in .github/workflows/build-notebooks-TEMPLATE.yaml and replace them with a concise reference comment
• Apply the same one-line replacement on both main and 2024b branches

---

⏳ Preparing changes...

[coderabbitai]

A summary of the changes CodeRabbit can apply:

• Remove duplicated GitHub documentation link comments on lines 173-174 in the build-notebooks-TEMPLATE.yaml file and replace them with a single concise reference comment for clarity.

• ✅ Create PR with these edits
• 📋 Get copyable edits