Skip to content

Commit fe1662d

Browse files
njzjzpre-commit-ci[bot]Copilot
authored
breaking: prepare to deprecate the devel branch (#5122)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated installation and contributor guides to reference the master development flow and revised download/setup instructions. * Clarified contributor workflow to create and use new branches instead of working directly on the old development branch. * **Chores** * CI/CD workflows and deployment now target the master branch for pushes; Pages deployment triggers on master. * Removed obsolete automation/autoupdate settings and explicit branch targets from config. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Jinzhe Zeng <njzjz@qq.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent b98f6c5 commit fe1662d

7 files changed

Lines changed: 13 additions & 26 deletions

File tree

.github/dependabot.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ updates:
44
directory: "/"
55
schedule:
66
interval: "weekly"
7-
target-branch: "devel"
87
- package-ecosystem: "pip"
98
directory: "/"
109
schedule:
1110
interval: "weekly"
12-
target-branch: "devel"

.github/workflows/build_wheel.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ jobs:
175175
name: github-pages
176176
url: ${{ steps.deployment.outputs.page_url }}
177177
runs-on: ubuntu-latest
178-
if: github.event_name == 'push' && github.ref == 'refs/heads/devel' && github.repository_owner == 'deepmodeling'
178+
if: github.event_name == 'push' && github.ref == 'refs/heads/master' && github.repository_owner == 'deepmodeling'
179179
steps:
180180
- name: Deploy to GitHub Pages
181181
id: deployment

.github/workflows/todo.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: TODO workflow
22
on:
33
push:
44
branches:
5-
- devel
5+
- master
66
jobs:
77
build:
88
if: github.repository_owner == 'deepmodeling'

.pre-commit-config.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,5 +159,3 @@ repos:
159159
- id: pylint
160160
entry: env PYTHONPATH=source/checker pylint
161161
files: ^deepmd/
162-
ci:
163-
autoupdate_branch: devel

CONTRIBUTING.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,6 @@ You can help other users of deepmd-kit in the following way
3636

3737
## Before you contribute
3838

39-
### Overview of DeePMD-kit
40-
41-
Currently, we maintain two main branch:
42-
43-
- master: stable branch with version tag
44-
- devel : branch for developers
45-
4639
### Developer guide
4740

4841
See [documentation](https://deepmd.readthedocs.io/) for coding conventions, API and other needs-to-know of the code.
@@ -58,13 +51,11 @@ Please perform the following steps to create your Pull Request to this repositor
5851

5952
### Step 2: Clone the forked repository to local storage and set configurations
6053

61-
1. Clone your own repo, not the public repo (from deepmodeling) ! And change the branch to devel.
54+
1. Clone your own repo, not the public repo (from deepmodeling) !
6255

6356
```bash
6457
git clone https://github.com/$username/deepmd-kit.git
6558
# Replace `$username` with your GitHub ID
66-
67-
git checkout devel
6859
```
6960

7061
2. Add deepmodeling's repo as your remote repo, we can name it "upstream". And fetch upstream's latest codes to your workstation.
@@ -76,23 +67,23 @@ Please perform the following steps to create your Pull Request to this repositor
7667
git fetch upstream
7768

7869
# If your current codes are behind the latest codes, you should merge latest codes first.
79-
# Notice you should merge from "devel"!
80-
git merge upstream/devel
70+
git merge upstream/master
8171
```
8272

8373
3. Modify your codes and design unit tests.
8474

85-
4. Commit your changes
75+
4. Commit your changes to a new branch
8676

8777
```bash
78+
git checkout -b branch1
8879
git status # Checks the local status
8980
git add <file> ... # Adds the file(s) you want to commit. If you want to commit all changes, you can directly use `git add.`
9081
git commit -m "commit-message: update the xx"
9182
```
9283

9384
5. Push the changed codes to your original repo on github.
9485
```bash
95-
git push origin devel
86+
git push origin branch1
9687
```
9788

9889
### Alternatively: Create a new branch

doc/install/easy-install-dev.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Easy install the latest development version
22

3-
DeePMD-kit is actively developed in the `devel` branch. The documentation of the [`latest`](https://docs.deepmodeling.com/projects/deepmd/en/latest/) version matches the `devel` branch.
3+
DeePMD-kit is actively developed in the `master` branch. The documentation of the [`latest`](https://docs.deepmodeling.com/projects/deepmd/en/latest/) version matches the `master` branch.
44

55
The following is the way to install the pre-compiled packages without [building from source](./install-from-source.md). All of them are built with [GitHub Actions](../development/cicd.md).
66

77
## Install with docker
88

9-
The [`devel` tag](https://github.com/deepmodeling/deepmd-kit/pkgs/container/deepmd-kit/131827568?tag=devel) is used to mark the latest development version with CUDA 12.2 support:
9+
The `master` tag is used to mark the latest development version with CUDA 12.2 support:
1010

1111
```bash
12-
docker pull ghcr.io/deepmodeling/deepmd-kit:devel
12+
docker pull ghcr.io/deepmodeling/deepmd-kit:master
1313
```
1414

1515
## Install with pip
@@ -26,10 +26,10 @@ pip install -U --pre deepmd-kit[gpu,cu12,lmp,torch] --extra-index-url https://de
2626
**Supported backends**: TensorFlow {{ tensorflow_icon }}
2727
:::
2828

29-
The [pre-comiled C library](./install-from-c-library.md) can be downloaded from [here](https://nightly.link/deepmodeling/deepmd-kit/workflows/package_c/devel/libdeepmd_c-0-libdeepmd_c.tar.gz.zip), or via a shell command:
29+
The [pre-compiled C library](./install-from-c-library.md) can be downloaded from [here](https://nightly.link/deepmodeling/deepmd-kit/workflows/package_c/master/libdeepmd_c-0-libdeepmd_c.tar.gz.zip), or via a shell command:
3030

3131
```sh
32-
wget https://nightly.link/deepmodeling/deepmd-kit/workflows/package_c/devel/libdeepmd_c-0-libdeepmd_c.tar.gz.zip && unzip libdeepmd_c-0-libdeepmd_c.tar.gz.zip
32+
wget https://nightly.link/deepmodeling/deepmd-kit/workflows/package_c/master/libdeepmd_c-0-libdeepmd_c.tar.gz.zip && unzip libdeepmd_c-0-libdeepmd_c.tar.gz.zip
3333
```
3434

3535
## Pre-release conda-forge packages

doc/install/install-from-source.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Install from source code
22

3-
Please follow our [GitHub](https://github.com/deepmodeling/deepmd-kit) webpage to download the [latest released version](https://github.com/deepmodeling/deepmd-kit/tree/master) and [development version](https://github.com/deepmodeling/deepmd-kit/tree/devel).
3+
Please follow our [GitHub](https://github.com/deepmodeling/deepmd-kit) webpage to download the source code of a specific version or the [development version](https://github.com/deepmodeling/deepmd-kit/tree/master).
44

55
Or get the DeePMD-kit source code by `git clone`
66

0 commit comments

Comments
 (0)