Skip to content

ci: sync skill-card.md versions in update-version flow - #1669

Merged
ramakrishnap-nv merged 4 commits into
mainfrom
fix/skill-card-version-sync
Aug 5, 2026
Merged

ci: sync skill-card.md versions in update-version flow#1669
ramakrishnap-nv merged 4 commits into
mainfrom
fix/skill-card-version-sync

Conversation

@ramakrishnap-nv

Copy link
Copy Markdown
Collaborator

Summary

Fixes #1667.

  • ci/utils/sync_skills_version.sh: adds a loop over skills/*/skill-card.md that updates the version token on the line under ## Skill Version(s): (e.g. 26.08.00 (source: frontmatter) <br>26.10.00 (source: frontmatter) <br>), preserving the source annotation.
  • ci/utils/validate_skills.sh: adds a check that each skill-card.md version matches the VERSION file, emitting the same Run: ./ci/utils/sync_skills_version.sh hint on mismatch.

Testing

Verified by temporarily bumping VERSION to 26.10.00, running sync_skills_version.sh (all 9 skill-card.md files updated), then validate_skills.sh (passes). Restored to 26.08.00 and confirmed clean.

Docs

No doc changes needed.

@ramakrishnap-nv
ramakrishnap-nv requested a review from a team as a code owner August 5, 2026 14:59
@ramakrishnap-nv ramakrishnap-nv self-assigned this Aug 5, 2026
@ramakrishnap-nv ramakrishnap-nv added non-breaking Introduces a non-breaking change improvement Improves an existing functionality labels Aug 5, 2026
@ramakrishnap-nv ramakrishnap-nv added this to the 26.10 milestone Aug 5, 2026
@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown

CI Test Summary

⏭️ All 5 test job(s) skipped.

@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 13652322-0616-4849-a9ba-404642889446

📥 Commits

Reviewing files that changed from the base of the PR and between 4c27a0b and ed21d3b.

📒 Files selected for processing (9)
  • skills/cuopt-developer/skill-card.md
  • skills/cuopt-install/skill-card.md
  • skills/cuopt-multi-objective-exploration/skill-card.md
  • skills/cuopt-numerical-optimization-api/skill-card.md
  • skills/cuopt-numerical-optimization-formulation/skill-card.md
  • skills/cuopt-routing-api-python/skill-card.md
  • skills/cuopt-server-api-python/skill-card.md
  • skills/cuopt-skill-evolution/skill-card.md
  • skills/cuopt-user-rules/skill-card.md

📝 Walkthrough

Walkthrough

The release synchronization script updates versions in skills/*/skill-card.md. Skill validation checks optional skill cards for a three-component version that matches VERSION. Nine skill cards now use version 26.10.00.

Changes

Skill card versioning

Layer / File(s) Summary
Synchronize skill card versions
ci/utils/sync_skills_version.sh, skills/*/skill-card.md
The script updates each skill-card version after the skill-version header and reports missing or malformed lines. Nine skill cards change from 26.08.00 to 26.10.00.
Validate skill card versions
ci/utils/validate_skills.sh
Validation reports missing or mismatched skill-card versions and increments ERRORS.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested reviewers: iroy30, tmckayus, afender

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The PR adds synchronization and validation logic, but the provided changes do not show update-version.sh integration or automated coverage required by #1667. Wire sync_skills_version.sh into update-version.sh and add automated coverage for skill-card version synchronization.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the synchronization of skill-card.md versions in the update-version flow.
Description check ✅ Passed The description directly explains the synchronization and validation changes for skill-card.md versions.
Out of Scope Changes check ✅ Passed The changes are limited to skill-card version synchronization, validation, and related version updates required by #1667.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/skill-card-version-sync

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🧹 Nitpick comments (1)
ci/utils/sync_skills_version.sh (1)

52-60: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Add automated coverage for the synchronization contract.

Cover these cases:

  • Update the line after ## Skill Version(s):.
  • Preserve the source annotation.
  • Leave unrelated version-looking lines unchanged.
  • Handle a missing version line consistently with validation.

As per coding guidelines, contributors must add unit tests for code changes.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@ci/utils/sync_skills_version.sh` around lines 52 - 60, Add automated tests
for the skill-card synchronization logic around the loop processing
skill-card.md files. Verify it updates only the version line immediately
following “## Skill Version(s):”, preserves the source annotation, leaves
unrelated version-looking lines unchanged, and handles a missing version line
consistently with the existing validation behavior.

Source: Coding guidelines

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@ci/utils/sync_skills_version.sh`:
- Around line 57-58: Update the synchronization logic around the sed command in
ci/utils/sync_skills_version.sh:57-58 to detect zero replacements, insert the
expected version line beneath “## Skill Version(s):” when missing, or fail with
a clear manual-repair error when malformed. In
ci/utils/validate_skills.sh:62-64, retain the sync command only because it can
create missing lines; otherwise change the remediation message to require manual
repair.
- Line 57: Update the sed substitution in the sync_skills_version script to
target only the version line immediately following the “## Skill Version(s):”
header, rather than every matching version-format line in skill-card.md.
Preserve the existing RELEASE_VERSION replacement and suffix handling while
preventing changes to examples or unrelated version lines.

---

Nitpick comments:
In `@ci/utils/sync_skills_version.sh`:
- Around line 52-60: Add automated tests for the skill-card synchronization
logic around the loop processing skill-card.md files. Verify it updates only the
version line immediately following “## Skill Version(s):”, preserves the source
annotation, leaves unrelated version-looking lines unchanged, and handles a
missing version line consistently with the existing validation behavior.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 2b441c41-872b-428f-9fd4-ea660b6161a3

📥 Commits

Reviewing files that changed from the base of the PR and between 652a4b1 and 5c9acaf.

📒 Files selected for processing (2)
  • ci/utils/sync_skills_version.sh
  • ci/utils/validate_skills.sh

Comment thread ci/utils/sync_skills_version.sh Outdated
Comment thread ci/utils/sync_skills_version.sh Outdated
Comment on lines +57 to +58
sed -i "s|^[0-9][0-9]\.[0-9][0-9]\.[0-9][0-9]\( (source:.*) <br>\)$|${RELEASE_VERSION}\1|" "$skill_card"
echo " updated $skill_card"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win

Keep synchronization and validation remediation consistent.

A missing or malformed card version is reported with a command that cannot repair it. sed performs zero substitutions without failing, and the sync script still prints updated.

  • ci/utils/sync_skills_version.sh#L57-L58: detect zero replacements and either insert the expected version line under ## Skill Version(s): or fail with a clear manual-repair error.
  • ci/utils/validate_skills.sh#L62-L64: keep the sync command only if it can create the missing line; otherwise report the required manual repair.
📍 Affects 2 files
  • ci/utils/sync_skills_version.sh#L57-L58 (this comment)
  • ci/utils/validate_skills.sh#L62-L64
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@ci/utils/sync_skills_version.sh` around lines 57 - 58, Update the
synchronization logic around the sed command in
ci/utils/sync_skills_version.sh:57-58 to detect zero replacements, insert the
expected version line beneath “## Skill Version(s):” when missing, or fail with
a clear manual-repair error when malformed. In
ci/utils/validate_skills.sh:62-64, retain the sync command only because it can
create missing lines; otherwise change the remediation message to require manual
repair.

@ramakrishnap-nv
ramakrishnap-nv requested a review from a team as a code owner August 5, 2026 19:12
@ramakrishnap-nv
ramakrishnap-nv requested a review from Iroy30 August 5, 2026 19:12
@ramakrishnap-nv

Copy link
Copy Markdown
Collaborator Author

/nskills-ci

@ramakrishnap-nv
ramakrishnap-nv merged commit 10252f4 into main Aug 5, 2026
42 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement Improves an existing functionality non-breaking Introduces a non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Synchronize skill-card versions in update-version.sh

3 participants