Skip to content

ci: support dynamic branch-aware documentation links in dashboard - #342

Open
srinivasugithub wants to merge 3 commits into
eclipse-score:mainfrom
bgsw-contrib:feature/dashboard-branch-links
Open

ci: support dynamic branch-aware documentation links in dashboard#342
srinivasugithub wants to merge 3 commits into
eclipse-score:mainfrom
bgsw-contrib:feature/dashboard-branch-links

Conversation

@srinivasugithub

Copy link
Copy Markdown
Contributor

This PR resolves #221. It replaces the hardcoded '/main/' subpaths in external documentation links with dynamic branch references, and changes absolute status dashboard links in Sphinx docs to local relative paths so that the dashboard functions perfectly on other branches and Pull Requests (PRs).

@github-actions

Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html

@srinivasugithub srinivasugithub self-assigned this Sep 12, 2026
@srinivasugithub

Copy link
Copy Markdown
Contributor Author

Fixes #221

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Unresolved branch-link and documentation-link issues remain, along with requested test coverage.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Updates dashboard and documentation links to support branch- and PR-specific deployments instead of hardcoded main paths.

Changes:

  • Adds dynamic branch resolution to generated report links.
  • Updates report templates with branch-aware URLs.
  • Converts documentation dashboard links to relative paths.
File summaries
File Summary
scripts/tooling/cli/misc/html_report.py Resolves the branch for generated links; PR-head precedence and test coverage require updates.
scripts/tooling/cli/misc/assets/report_template.html Uses dynamic S-CORE documentation URLs.
docs/integration_process/reference.rst Uses a relative dashboard link.
docs/index.rst Uses a local dashboard link, but a hidden toctree entry still references main.
Review details
  • Files reviewed: 4/4 changed files
  • Comments generated: 3
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/index.rst
Reference Integration workflow and health overview with links to
:doc:`Integration Process <integration_process/integration_process>` and
`Integration Status <https://eclipse-score.github.io/reference_integration/main/status_dashboard.html>`_.
`Integration Status <status_dashboard.html>`_.
Comment on lines +132 to +133
# 1. Try GITHUB_REF_NAME environment variable (standard in GitHub Actions)
ref_name = os.environ.get("GITHUB_REF_NAME")
if token:
_enrich_with_compare_data(entries, token)

branch = _get_current_branch()

@PiotrKorkus PiotrKorkus left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Module Integration Dashboard improvements

4 participants