breaking: prepare to deprecate the devel branch
#5122
Conversation
for more information, see https://pre-commit.ci
|
I think the |
There was a problem hiding this comment.
Pull request overview
This PR transitions the DeePMD-kit repository from a two-branch development model (master for stable releases, devel for development) to a single-branch model where master serves as the primary development branch. This is a breaking change that updates all references to the devel branch across documentation, workflows, and configuration files.
- Updated documentation to reflect that
masteris now the development branch - Changed GitHub Actions workflows to trigger on
masterinstead ofdevel - Removed the two-branch overview from CONTRIBUTING.md and updated contribution instructions
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/install/install-from-source.md | Updated to reference master as the development version instead of devel |
| doc/install/easy-install-dev.md | Changed all references from devel to master for Docker tags, download links, and branch documentation |
| CONTRIBUTING.md | Removed two-branch overview section and updated contribution workflow to use master branch and new branch creation pattern |
| .pre-commit-config.yaml | Removed autoupdate_branch: devel configuration |
| .github/workflows/todo.yml | Changed workflow trigger from devel to master branch |
| .github/workflows/build_wheel.yml | Updated GitHub Pages deployment condition to check for master branch |
| .github/dependabot.yml | Removed target-branch: "devel" settings for both github-actions and pip ecosystems |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. 📝 WalkthroughWalkthroughUpdate branch references from Changes
Sequence Diagram(s)(omitted) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Pre-merge checks✅ Passed checks (3 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## devel #5122 +/- ##
=======================================
Coverage 82.15% 82.15%
=======================================
Files 709 709
Lines 72468 72467 -1
Branches 3616 3615 -1
=======================================
+ Hits 59535 59537 +2
+ Misses 11769 11768 -1
+ Partials 1164 1162 -2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Jinzhe Zeng <njzjz@qq.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Fix all issues with AI Agents 🤖
In @doc/install/easy-install-dev.md:
- Line 29: The documentation currently links to pre-compiled C library artifacts
without any verification guidance; update the doc/install/easy-install-dev.md
entries that reference the pre-compiled C library (the "pre-compiled C library"
link and the nightly.link URL) to require and demonstrate checksum or signature
verification: advise publishing or linking to versioned release artifacts from a
trusted channel, add SHA256 (or better) checksum values and an example
verification command (or a GPG signature + verification flow) for the tarball,
and include a short note telling users to verify the checksum/signature before
extraction and installation.
- Line 29: Replace the vague link anchor text "here" in the sentence that points
to
https://nightly.link/deepmodeling/deepmd-kit/workflows/package_c/master/libdeepmd_c-0-libdeepmd_c.tar.gz.zip
with a descriptive label such as "pre-compiled libdeepmd_c archive" (or
"pre-compiled C library archive") in doc/install/easy-install-dev.md so the link
text conveys its destination instead of using "here".
📜 Review details
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
doc/install/easy-install-dev.md
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-12-12T13:40:14.334Z
Learnt from: CR
Repo: deepmodeling/deepmd-kit PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-12T13:40:14.334Z
Learning: Always install backend dependencies (TensorFlow/PyTorch) before building C++ components
Applied to files:
doc/install/easy-install-dev.md
🪛 markdownlint-cli2 (0.18.1)
doc/install/easy-install-dev.md
29-29: Link text should be descriptive
(MD059, descriptive-link-text)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (28)
- GitHub Check: Analyze (c-cpp)
- GitHub Check: Analyze (python)
- GitHub Check: Build wheels for cp311-macosx_x86_64
- GitHub Check: Build wheels for cp310-manylinux_aarch64
- GitHub Check: Build wheels for cp311-macosx_arm64
- GitHub Check: Build wheels for cp311-win_amd64
- GitHub Check: Test Python (4, 3.13)
- GitHub Check: Build wheels for cp311-manylinux_x86_64
- GitHub Check: Build C++ (rocm, rocm)
- GitHub Check: Build C library (2.18, libdeepmd_c.tar.gz)
- GitHub Check: Build C++ (clang, clang)
- GitHub Check: Build C++ (cpu, cpu)
- GitHub Check: Test Python (4, 3.10)
- GitHub Check: Test Python (2, 3.13)
- GitHub Check: Test Python (5, 3.13)
- GitHub Check: Build C++ (cuda120, cuda)
- GitHub Check: Test Python (5, 3.10)
- GitHub Check: Test Python (2, 3.10)
- GitHub Check: Test Python (3, 3.13)
- GitHub Check: Test Python (6, 3.13)
- GitHub Check: Test Python (1, 3.10)
- GitHub Check: Test Python (1, 3.13)
- GitHub Check: Test Python (3, 3.10)
- GitHub Check: Test Python (6, 3.10)
- GitHub Check: Test C++ (true, true, true, false)
- GitHub Check: Test C++ (false, true, true, false)
- GitHub Check: Test C++ (true, false, false, true)
- GitHub Check: Test C++ (false, false, false, true)
🔇 Additional comments (1)
doc/install/easy-install-dev.md (1)
3-3: Branch reference updates are consistent and align with PR objective.The changes from
develtomasteracross the documentation, Docker tag, and artifact download paths are coherent and directly support the branch deprecation goal.Also applies to: 9-9, 12-12, 32-32
3 participants
Summary by CodeRabbit
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.