diff --git a/.github/dependabot.yml b/.github/dependabot.yml index e30369fcea..cbd920f6b3 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -4,9 +4,7 @@ updates: directory: "/" schedule: interval: "weekly" - target-branch: "devel" - package-ecosystem: "pip" directory: "/" schedule: interval: "weekly" - target-branch: "devel" diff --git a/.github/workflows/build_wheel.yml b/.github/workflows/build_wheel.yml index c21d856de2..5385855e2e 100644 --- a/.github/workflows/build_wheel.yml +++ b/.github/workflows/build_wheel.yml @@ -175,7 +175,7 @@ jobs: name: github-pages url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest - if: github.event_name == 'push' && github.ref == 'refs/heads/devel' && github.repository_owner == 'deepmodeling' + if: github.event_name == 'push' && github.ref == 'refs/heads/master' && github.repository_owner == 'deepmodeling' steps: - name: Deploy to GitHub Pages id: deployment diff --git a/.github/workflows/todo.yml b/.github/workflows/todo.yml index abeabda73b..25cb02aba2 100644 --- a/.github/workflows/todo.yml +++ b/.github/workflows/todo.yml @@ -2,7 +2,7 @@ name: TODO workflow on: push: branches: - - devel + - master jobs: build: if: github.repository_owner == 'deepmodeling' diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 8b1cb50124..599b005309 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -159,5 +159,3 @@ repos: - id: pylint entry: env PYTHONPATH=source/checker pylint files: ^deepmd/ -ci: - autoupdate_branch: devel diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1358a9678c..67491672e8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,13 +36,6 @@ You can help other users of deepmd-kit in the following way ## Before you contribute -### Overview of DeePMD-kit - -Currently, we maintain two main branch: - -- master: stable branch with version tag -- devel : branch for developers - ### Developer guide 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 ### Step 2: Clone the forked repository to local storage and set configurations -1. Clone your own repo, not the public repo (from deepmodeling) ! And change the branch to devel. +1. Clone your own repo, not the public repo (from deepmodeling) ! ```bash git clone https://github.com/$username/deepmd-kit.git # Replace `$username` with your GitHub ID - - git checkout devel ``` 2. Add deepmodeling's repo as your remote repo, we can name it "upstream". And fetch upstream's latest codes to your workstation. @@ -76,15 +67,15 @@ Please perform the following steps to create your Pull Request to this repositor git fetch upstream # If your current codes are behind the latest codes, you should merge latest codes first. - # Notice you should merge from "devel"! - git merge upstream/devel + git merge upstream/master ``` 3. Modify your codes and design unit tests. -4. Commit your changes +4. Commit your changes to a new branch ```bash + git checkout -b branch1 git status # Checks the local status git add ... # Adds the file(s) you want to commit. If you want to commit all changes, you can directly use `git add.` git commit -m "commit-message: update the xx" @@ -92,7 +83,7 @@ Please perform the following steps to create your Pull Request to this repositor 5. Push the changed codes to your original repo on github. ```bash - git push origin devel + git push origin branch1 ``` ### Alternatively: Create a new branch diff --git a/doc/install/easy-install-dev.md b/doc/install/easy-install-dev.md index 6da75a3bb6..9a0154320e 100644 --- a/doc/install/easy-install-dev.md +++ b/doc/install/easy-install-dev.md @@ -1,15 +1,15 @@ # Easy install the latest development version -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. +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. 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). ## Install with docker -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: +The `master` tag is used to mark the latest development version with CUDA 12.2 support: ```bash -docker pull ghcr.io/deepmodeling/deepmd-kit:devel +docker pull ghcr.io/deepmodeling/deepmd-kit:master ``` ## Install with pip @@ -26,10 +26,10 @@ pip install -U --pre deepmd-kit[gpu,cu12,lmp,torch] --extra-index-url https://de **Supported backends**: TensorFlow {{ tensorflow_icon }} ::: -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: +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: ```sh -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 +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 ``` ## Pre-release conda-forge packages diff --git a/doc/install/install-from-source.md b/doc/install/install-from-source.md index e523c5b220..1e03563c66 100644 --- a/doc/install/install-from-source.md +++ b/doc/install/install-from-source.md @@ -1,6 +1,6 @@ # Install from source code -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). +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). Or get the DeePMD-kit source code by `git clone`