feat: Update a wiki page with the compatibility check markdown #1403
Conversation
- Auto-generate detailed compatibility report in Wiki - Update README badge to link to Wiki page instead of workflow runs - Include summary, status indicators, and fix instructions - Only update Wiki on main branch pushes - Generate timestamps and links to workflow runs Assisted-by: Cursor
github-actions
bot
added
the
non-workspace-changes
polasudo
requested review from
davidfestal,
gashcrumb and
kadel
as code owners
| GITHUB_REPOSITORY: ${{ github.repository }} | ||
| run: | | ||
| # Create the compatibility report markdown header | ||
| cat > compatibility-report.md << EOF |
There was a problem hiding this comment.
Instead of creating this markdown here, why not save the markdown already built in the reusable workflow, as an artifact, and retrieve it (with a download-artifact action) here from the reusable workflow (needs.check) ?
|
please link to the associated JIRA for this task. |
- Add fallback report creation when compatibility-report.md is missing - Better error messaging and verification of downloaded artifact
| if [ -f "compatibility-report.md" ]; then | ||
| echo "Successfully downloaded compatibility-report.md" | ||
| else | ||
| echo "❌ compatibility-report.md not found, creating fallback report" |
There was a problem hiding this comment.
Instead of creating a fallback report that will be updated I need the wiki page, shouldn't we fail, and not update the Wiki at all ?
Or we could add a warning at the top of the existing wiki content in order to notify that the Wiki content is possibly obsolete due to the failure of the given Workflow run (with a link to the workflow run) ?
But just replacing the content of the wiki page with a dummy report doesn't seem helpful to me.
There was a problem hiding this comment.
yeah i will just add log and this will be it
| git config user.email "github-actions[bot]@users.noreply.github.com" | ||
| # Copy the generated markdown to wiki (use test name for testing branches) | ||
| if [ "${{ github.ref }}" = "refs/heads/feat/RHIDP-8649" ]; then |
There was a problem hiding this comment.
I assume this is just for testing, and will be removed before merging this PR ?
- Fail workflow instead of creating fallback report when compatibility report is missing - Remove test branch conditions for feat/RHIDP-8649 branch - Simplify wiki update to always use production filename
|
/publish |
|
PR action ( |
3 participants
introducing an automated workflow to generate and update a Backstage compatibility report in the repository's wiki, and updates the README badge link to point directly to this report for better visibility.
Jira Issue: RHIDP-8649