Skip to content

Fix invalid relative links in welcome workflow comments#488

Open
kannon92 wants to merge 1 commit intoNVIDIA:mainfrom
kannon92:invalid-comment-issue
Open

Fix invalid relative links in welcome workflow comments#488
kannon92 wants to merge 1 commit intoNVIDIA:mainfrom
kannon92:invalid-comment-issue

Conversation

@kannon92
Copy link
Copy Markdown

@kannon92 kannon92 commented Apr 3, 2026

Summary

Fix broken relative links in the GitHub Actions welcome workflow that produced invalid URLs in issue and PR welcome comments.

Motivation / Context

The welcome workflow used relative markdown links (e.g., ../blob/main/CONTRIBUTING.md, ../../labels) which don't resolve correctly when rendered in GitHub issue/PR comments. This caused new contributors to encounter broken links on their first interaction with the project.

Fixes: N/A
Related: N/A

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Refactoring (no functional changes)
  • Build/CI/tooling

Component(s) Affected

  • CLI (cmd/aicr, pkg/cli)
  • API server (cmd/aicrd, pkg/api, pkg/server)
  • Recipe engine / data (pkg/recipe)
  • Bundlers (pkg/bundler, pkg/component/*)
  • Collectors / snapshotter (pkg/collector, pkg/snapshotter)
  • Validator (pkg/validator)
  • Core libraries (pkg/errors, pkg/k8s)
  • Docs/examples (docs/, examples/)
  • Other: GitHub Actions workflow (.github/workflows/welcome.yaml)

Implementation Notes

Replaced relative markdown links with fully-qualified GitHub URLs using context.repo.owner and context.repo.repo template variables. This ensures links resolve correctly regardless of where the comment is rendered. Changed the affected lines from single-quoted strings to template literals to enable variable interpolation.

Testing

# Verified the template literal syntax is valid JavaScript
# Confirmed the generated URLs match the expected format:
# https://github.com/NVIDIA/aicr/blob/main/CONTRIBUTING.md
# https://github.com/NVIDIA/aicr/labels
# https://github.com/NVIDIA/aicr/discussions

Risk Assessment

  • Low — Isolated change, well-tested, easy to revert
  • Medium — Touches multiple components or has broader impact
  • High — Breaking change, affects critical paths, or complex rollout

Rollout notes: N/A

Checklist

  • Tests pass locally (make test with -race)
  • Linter passes (make lint)
  • I did not skip/disable tests to make CI green
  • I added/updated tests for new functionality
  • I updated docs if user-facing behavior changed
  • Changes follow existing patterns in the codebase
  • Commits are cryptographically signed (git commit -S) — GPG signing info

@kannon92 kannon92 requested a review from a team as a code owner April 3, 2026 14:38
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot bot commented Apr 3, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 3, 2026

Welcome to AICR, @kannon92! Thanks for your first pull request.

Before review, please ensure:

  • All commits are signed off per the DCO
  • CI checks pass (tests, lint, security scan)
  • The PR description explains the why behind your changes

A maintainer will review this soon.

Copy link
Copy Markdown
Member

@mchmarny mchmarny left a comment

Choose a reason for hiding this comment

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

/lgtm

@mchmarny mchmarny enabled auto-merge (squash) April 3, 2026 15:33
@mchmarny mchmarny added the documentation Improvements or additions to documentation label Apr 3, 2026
Signed-off-by: Kevin Hannon <kehannon@redhat.com>
auto-merge was automatically disabled April 3, 2026 19:50

Head branch was pushed to by a user without write access

@kannon92 kannon92 force-pushed the invalid-comment-issue branch from 88fd4ba to 2d6b378 Compare April 3, 2026 19:50
@kannon92 kannon92 requested a review from mchmarny April 3, 2026 19:50
@kannon92
Copy link
Copy Markdown
Author

kannon92 commented Apr 3, 2026

@mchmarny I had to repush to sign my commits. So this probably needs a new approver but nothng else changed.

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

Labels

area/ci documentation Improvements or additions to documentation size/XS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants