--- name: bump-dependency-4f93bdce75b4 description: Bump a pinned dependency (TransformerEngine, Megatron-LM, NRX, etc.), regenerate the lockfile, open a PR, and drive it to green by attaching a watchdog to the "CICD NeMo" workflow and quarantining failing functional tests as flaky until the run is green. when_to_use: Bumping a dependency pin in `pyproject.toml` or `uv.lock` and shepherding the PR to green. 'bump TE', 'bump transformer-engine', 'update TE pin', 'bump submodule', 'update lock file', 'bump dependency PR', 'watch CI for a bump', 'quarantine flaky tests after bump', 'run all tests for this bump'. --- # Bump Dependency End-to-end workflow for shipping a dependency bump in Megatron Bridge. Optimised for the case where TE, MCore, or another GPU-heavy pin moves forward — which often surfaces flakes that have to be quarantined before the PR can land. The pipeline is always: **edit → relock → push → /ok to test → watchdog → quarantine on red → re-trigger → repeat until green**. ## When to reach for this skill - Bumping a git-source pin in `pyproject.toml` `override-dependencies` (e.g. `transformer-engine @ git+...@`). - Bumping the `3rdparty/Megatron-LM` submodule. - Any change that touches `uv.lock` and needs the full L0 + L1 matrix to prove out before merge. For pure dep additions/removals without a CI loop, the `build-and-dependency` skill is enough. ## Required context Read first, then follow the steps below: - @CONTRIBUTING.md — PR title/label policy, DCO sign-off - @skills/build-and-dependency/SKILL.md — `uv lock` mechanics, container choice - @skills/cicd/SKILL.md — how `copy-pr-bot` and `/ok to test` work - @skills/testing/SKILL.md — `active/` vs `flaky/` directory layout, `git mv` quarantine recipe ## Step 1 — Worktree and edit Create a worktree off `main` per @CLAUDE.md. Then, **before any `uv lock`**: ```bash git submodule update --init 3rdparty/Megatron-LM ``` The submodule must be initialised in the worktree or `uv lock` errors with "not a Python project" on the MCore path. Edit the pin. For TE the canonical knob is the override line in `pyproject.toml`: ```toml override-dependencies = [ ... "transformer-engine @ git+https://github.com/NVIDIA/TransformerEngine.git@", ... ] ``` Use a **branch name** (`release_v2.15`) only when you want to track a moving tip; use a full SHA for reproducibility. TE branches use `release_vX.Y` (underscore), not `release/vX.Y`. Verify with `git ls-remote https://github.com/NVIDIA/TransformerEngine.git`. ## Step 2 — Regenerate the lockfile Run `uv lock` inside the project container per @skills/build-and-dependency/SKILL.md "Regenerating uv.lock". Then confirm only the intended packages moved: ```bash git diff --stat pyproject.toml uv.lock ``` If the diff carries changes you didn't ask for (transitive movements you can't explain), stop and investigate before pushing. Note that `override-dependencies` carries CVE floors that float — unrelated packages bumping by a patch version is expected; accept those, don't revert them. ## Step 3 — Commit and push Sign-off + signed-commit + PR title format per @CONTRIBUTING.md and @skills/cicd/SKILL.md "Commit and PR Workflow". For a bump: ```bash git add pyproject.toml uv.lock git commit -S -s -m "build: bump to " git push -u origin ``` A signed commit (`-S`) lets `copy-pr-bot` trigger CI without manual `/ok to test` for the first push — but you'll still post `/ok to test` on every subsequent SHA in this loop (Step 5). ## Step 4 — Open the PR Title and labels per @CONTRIBUTING.md. Two bump-specific requirements: - Apply `needs-more-tests` — **mandatory** for a bump; expands the matrix from L0 to L0+L1. - For a high-blast-radius bump (TE, MCore submodule, anything that touches CUDA kernels), also apply `full-test-suite` to pull L2 into the PR run. L2 covers VL models, checkpoint conversion, and heavy quantization which otherwise only run on schedule. The PR body template — this is the durable record of the bump: ````markdown
Claude summary ## What - Bump to . - Regenerate `uv.lock`. ## Lockfile delta ``` Updated -> ``` ## Test plan - [ ] L0 CI green - [ ] L1 CI green (label `needs-more-tests` applied) ## Quarantined tests (this bump) _None yet — will be appended as flakes are identified during CI iteration._
```` To update the PR title or body later, use `gh api -X PATCH "repos/NVIDIA-NeMo/Megatron-Bridge/pulls/" -F "body=@/tmp/pr-body.md"` — never `gh pr edit`. ## Step 5 — Trigger CI on the exact SHA Trigger mechanics live in @skills/cicd/SKILL.md "How CI Is Triggered". For this loop the rule is simple: **on every new SHA you push, post `/ok to test $(git rev-parse HEAD)`** as a PR comment, even if your commits are signed. This guarantees the run targets the SHA you actually want exercised and re-fires anything that got cancelled or cached. ## Step 6 — Attach the watchdog (always; never a cronjob) For a bump PR you want a single live process that emits per-job state changes for the **CICD NeMo** workflow only. Other workflows (docs, wheel, copyright, install-test) are noise here — the gate that decides green-or-red for a bump is `CICD NeMo`. **Always attach a watchdog with the Monitor tool. Never schedule wakeups or cronjobs for this loop.** A watchdog gives you: - Sub-minute reaction time on every job transition. - A single live process — no scattered scheduled-wakeup state to reason about. - Natural early termination via `TaskStop` once the run is green. ### Watchdog script Save to `/tmp/watchdog-.sh` and chmod +x: ```bash #!/usr/bin/env bash # Watchdog: monitor "CICD NeMo" runs on pull-request/ and emit # per-job state changes. Stays alive across re-runs (new commits). set -u PR= REPO=NVIDIA-NeMo/Megatron-Bridge BRANCH="pull-request/$PR" prev_run_id="" declare -A prev_state emit() { echo "[$(date -u +%H:%M:%SZ)] $*"; } while true; do run_json=$(gh run list --repo "$REPO" --workflow "CICD NeMo" \ --branch "$BRANCH" --limit 1 \ --json databaseId,status,conclusion,headSha 2>/dev/null || echo "[]") run_id=$(echo "$run_json" | jq -r '.[0].databaseId // empty') run_status=$(echo "$run_json" | jq -r '.[0].status // empty') run_conclusion=$(echo "$run_json" | jq -r '.[0].conclusion // empty') run_sha=$(echo "$run_json" | jq -r '.[0].headSha // empty') if [[ -z "$run_id" ]]; then sleep 30; continue fi if [[ "$run_id" != "$prev_run_id" ]]; then emit "RUN ${run_id} STARTED sha=${run_sha:0:8} status=${run_status}" prev_run_id="$run_id" unset prev_state declare -A prev_state fi jobs_json=$(gh run view "$run_id" --repo "$REPO" --json jobs 2>/dev/null || echo "{}") while IFS=$'\t' read -r name status conclusion; do [[ -z "$name" ]] && continue cur="${status}/${conclusion}" if [[ "${prev_state[$name]:-}" != "$cur" ]]; then case "$status" in completed) emit "JOB ${name} -> ${conclusion}" ;; in_progress) if [[ -z "${prev_state[$name]:-}" || "${prev_state[$name]}" == "queued/" ]]; then emit "JOB ${name} -> in_progress" fi ;; esac prev_state[$name]="$cur" fi done < <(echo "$jobs_json" | jq -r '.jobs[]? | [.name, .status, (.conclusion // "")] | @tsv') if [[ "$run_status" == "completed" ]]; then emit "RUN ${run_id} COMPLETED conclusion=${run_conclusion}" fi sleep 60 done ``` ### Arming the watchdog ```text Monitor( description="CICD NeMo run state changes on PR ", command="bash /tmp/watchdog-.sh", persistent=true, timeout_ms=3600000 ) ``` `persistent: true` keeps it alive across re-runs (you'll push more commits when quarantining flakes). Stop it with `TaskStop()` once the run is green. ### Why never a cronjob / scheduled wakeup - Cronjobs run blind — they fire on a clock, not on an event. You'll either over-poll (cache miss every wake-up) or miss long stalls. - Wakeups can't easily fan out to "tell me whenever a job transitions" — they only resume the agent on a fixed interval. - A persistent Monitor surfaces every job edge in real time and exits cleanly when the work is done. ## Step 7 — Quarantine on red, then iterate When a `JOB -> failure` event fires: 1. **Triage the failure — is it the bump or a flake?** Skim the logs: ```bash RUN_ID= gh run view "$RUN_ID" --repo NVIDIA-NeMo/Megatron-Bridge --log-failed > /tmp/run.log wc -l /tmp/run.log tail -200 /tmp/run.log ``` This is the bump-specific judgement call: only quarantine if the failure reproduces on `main` or is clearly unrelated infrastructure. If the failure is caused by the bump (real regression), **stop quarantining** — fix the underlying issue or revert the bump. Quarantining a real regression hides the very signal the bump PR exists to surface. 2. **Move the launch script to `flaky/`** per @skills/testing/SKILL.md "Moving a Test to Flaky". Map a CI job name to its launch script via: - prefix `gb200_` → `gb200/active/`, otherwise `h100/active/` - the rest is the script's basename without `.sh` 3. **Append to the PR body's Quarantined tests section** with a one-line reason and a follow-up tracking link if you have one. This is the durable record of what this bump deferred — the section exists precisely so a reviewer can see at a glance which flakes were side-stepped to land the bump. 4. **Commit, push, retrigger**: ```bash git commit -S -s -m "ci: quarantine flaky for bump" git push gh pr comment --repo NVIDIA-NeMo/Megatron-Bridge \ --body "/ok to test $(git rev-parse HEAD)" ``` 5. **Update the PR body** via `gh api PATCH` so the quarantine list stays current. The watchdog is persistent — it picks up the new run automatically and emits `RUN STARTED` for the new attempt. Loop back to step 1. ## Step 8 — Stop when green `RUN COMPLETED conclusion=success` is the exit condition. Then: ```bash gh pr checks --repo NVIDIA-NeMo/Megatron-Bridge | awk '{print $2}' | sort | uniq -c TaskStop() gh api -X PATCH "repos/NVIDIA-NeMo/Megatron-Bridge/pulls/" -F "body=@/tmp/pr-body.md" ``` ## Common pitfalls | Symptom | Cause | Fix | |---|---|---| | Wrong TE branch ref (`release/v2.15`) silently resolves nothing | TE uses `release_vX.Y` with an underscore | Verify with `git ls-remote` before locking | | Lockfile diff includes unrelated CVE-pinned packages | `override-dependencies` carries floors that float | Re-run lock and accept; don't try to revert those | | Signed first push triggers CI but later pushes don't | `copy-pr-bot` re-trusts on each new SHA only via `/ok to test` once you're past the first signed commit in this loop | Always re-post `/ok to test $(git rev-parse HEAD)` per Step 5 | | Watchdog goes silent for 30+ min | `gh` rate-limited or auth expired | Bump poll interval; `gh auth status`; restart Monitor | | Job name doesn't map to a script in `active/` | `gb200_` prefix is the hardware indicator, not part of the filename | Strip `gb200_` and look in `gb200/active/` | ## Anti-patterns - **Cron / scheduled wakeups for this loop.** Always Monitor. - **Polling all workflows.** Filter to `CICD NeMo` — the rest are noise for a bump. - **Quarantining a real regression** to "make CI green." That defeats the purpose of the bump PR. Only quarantine if the failure reproduces on `main` or is clearly unrelated infrastructure. - **`gh pr edit`** for title/body. Use `gh api PATCH`. - **HEREDOC in `gh pr create --body`.** Always go through a tmpfile + `--body-file`. - **Bundling unrelated changes** (feature work, refactors) into a bump PR. Bumps should stay surgical so CI failures attribute cleanly. --- Source attribution: NVIDIA-NeMo Original project: https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/e301c817218e4e626c8c264aee9935514559a04b/skills/bump-dependency/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # Mega AI Hub resource metadata Creator / publisher: NVIDIA-NeMo Original project: https://github.com/NVIDIA-NeMo/Megatron-Bridge/blob/e301c817218e4e626c8c264aee9935514559a04b/skills/bump-dependency/SKILL.md Attribution basis: Source repository record Fields of work: Development & Engineering Roles: Backend Developer, DevOps / SRE, ML / AI Engineer Specialties: API, Backend, Database, Frontend, Git, Playwright, React, Testing Tools: Docker Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: a9a1d4489a9e3e245812ba3cb3f63bd7d4502e9eabf81ad075e180775234dd63