Zengtudor/pybind11
1
0
Fork 0
mirror of https://github.com/pybind/pybind11.git synced 2024-11-22 05:05:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: mention branch update in checklist (#2670)

Browse Source
This commit is contained in:
Henry Schreiner 2020-11-16 10:18:43 -05:00 committed by GitHub
parent 32d11c9653
commit 17c22b9e0f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/release.rst
View File

@ -33,8 +33,9 @@ To release a new version of pybind11:
issues are entered in the changelog (clear the label when done). issues are entered in the changelog (clear the label when done).
- ``git add`` and ``git commit``, ``git push``. **Ensure CI passes**. (If it - ``git add`` and ``git commit``, ``git push``. **Ensure CI passes**. (If it
fails due to a known flake issue, either ignore or restart CI.) fails due to a known flake issue, either ignore or restart CI.)
- Add a release branch if this is a new minor version - Add a release branch if this is a new minor version, or update the existing release branch if it is a patch version
- ``git checkout -b vX.Y``, ``git push -u origin vX.Y`` - New branch: ``git checkout -b vX.Y``, ``git push -u origin vX.Y``
- Update branch: ``git checkout vX.Y``, ``git merge <release branch>``, ``git push``
- Update tags (optional; if you skip this, the GitHub release makes a - Update tags (optional; if you skip this, the GitHub release makes a
non-annotated tag for you) non-annotated tag for you)
- ``git tag -a vX.Y.Z -m 'vX.Y.Z release'``. - ``git tag -a vX.Y.Z -m 'vX.Y.Z release'``.