ci: support dynamic branch-aware documentation links in dashboard - #342
Merged
PiotrKorkus merged 12 commits intoSep 22, 2026
Merged
PiotrKorkus merged 12 commits into
PiotrKorkus merged 12 commits into
Conversation
srinivasugithub
requested review from
AlexanderLanin,
FScholPer,
MaximilianSoerenPollak,
PiotrKorkus,
antonkri,
dcalavrezo-qorix,
lurtz,
nradakovic,
opajonk and
pawelrutkaq
as code owners
September 12, 2026 10:12
|
The created documentation from the pull request is available at: docu-html |
Contributor
Author
|
Fixes #221 |
Contributor
There was a problem hiding this comment.
🟡 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.
| 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
requested changes
Sep 14, 2026
PiotrKorkus
left a comment
PiotrKorkus
left a comment
Contributor
There was a problem hiding this comment.
http://eclipse-score.github.io/reference_integration/pr-342/
Still opens dashboard from main
PiotrKorkus
reviewed
Sep 21, 2026
|
|
||
| Modules <modules/index> | ||
| Verification Reports <verification_report/index> | ||
| Integration Status <https://eclipse-score.github.io/reference_integration/main/status_dashboard.html> |
Contributor
There was a problem hiding this comment.
keep the link at the top bar as before
PiotrKorkus
approved these changes
Sep 22, 2026
- Update docs/index.rst toctree to use a relative path with the '#http://' dummy anchor hack to bypass Sphinx validation while maintaining local resolution. - Modify _get_current_branch() in scripts/tooling/cli/misc/html_report.py to prefer GITHUB_HEAD_REF first to support pull_request_target workflows. - Add GITHUB_HEAD_REF and GITHUB_REF_NAME branch-selection unit tests to scripts/tooling/tests/test_report.py.
Move the subprocess import to the top of the file to comply with standard PEP 8 import style and avoid nested/deferred imports in _get_current_branch().
Replace direct `stdout` and `stderr` PIPE redirection with `capture_output=True` in `subprocess.run` to comply with the pyupgrade / ruff ruleset.
Format a long assertion line to comply with the line-length limits (120 chars) specified in pyproject.toml.
Create docs/status_dashboard.rst and add it to the docs/index.rst toctree to resolve previous build validation issues while keeping a proper integration status link.
Add a blank line after the copyright header block to resolve a docutils markup syntax error and prevent the CI preflight documentation build from failing.
PiotrKorkus
force-pushed
the
feature/dashboard-branch-links
branch
from
September 22, 2026 12:50
fed9f5a to
7553116
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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).