From 825f1ff1cef22032b6ebbf93618b7fff9d64c81d Mon Sep 17 00:00:00 2001 From: Sebastien Bourdeauducq Date: Thu, 7 Dec 2017 13:24:06 +0800 Subject: [PATCH] move RELEASING into DEVELOPER_NOTES --- DEVELOPER_NOTES.rst | 27 +++++++++++++++++++++++++++ RELEASING.rst | 26 -------------------------- 2 files changed, 27 insertions(+), 26 deletions(-) delete mode 100644 RELEASING.rst diff --git a/DEVELOPER_NOTES.rst b/DEVELOPER_NOTES.rst index 15975f5fd..2745760f7 100644 --- a/DEVELOPER_NOTES.rst +++ b/DEVELOPER_NOTES.rst @@ -1,3 +1,30 @@ +Release process +=============== + +Maintain ``RELEASE_NOTES.rst`` with a list of new features and API changes in each major release. + +Major releases +-------------- + +1. Create branch release-X from master. +2. Tag the next commit in master X+1.0.dev. +3. Ensure that release versions of all packages required are available under the ``main`` label in conda. Ensure that new packages in ``main`` do not break older ARTIQ releases. +4. In the release-X branch, remove any unfinished features. +5. Test and fix any problems found. Apply fixes to both master and release-X. +6. If you have willing testers for release candidates, tag X.0rc1 in the release-X branch (generally use signed annotated tags, i.e. ``git tag -sa X.0rc1``), have it build, and point testers there. Iterate over the previous points with new release candidates if necessary. +7. Tag X.0 in the release-X branch, build it, and copy its packages to ``main`` channel. +8. Mint a new DOI from Zenodo and update the README/introduction. +9. Update the m-labs.hk/artiq/manual redirect to point to m-labs.hk/artiq/manual-release-X (edit /artiq/.htaccess). +10. "Draft a new release" and close the milestone on GitHub. + +Minor (bugfix) releases +----------------------- + +1. Backport bugfixes from the master branch or fix bugs specific to old releases into the currently maintained release-X branch(es). +2. When significant bugs have been fixed, tag X.Y+1. +3. To help dealing with regressions, no new features or refactorings should be implemented in release-X branches. Those happen in the master branch, and then a new release-X+1 branch is created. +4. "Draft a new release" and close the milestone on GitHub. + Sharing development boards ========================== diff --git a/RELEASING.rst b/RELEASING.rst deleted file mode 100644 index d52f832ad..000000000 --- a/RELEASING.rst +++ /dev/null @@ -1,26 +0,0 @@ -Release process -=============== - -Maintain ``RELEASE_NOTES.rst`` with a list of new features and API changes in each major release. - -Major releases --------------- - -1. Create branch release-X from master. -2. Tag the next commit in master X+1.0.dev. -3. Ensure that release versions of all packages required are available under the ``main`` label in conda. Ensure that new packages in ``main`` do not break older ARTIQ releases. -4. In the release-X branch, remove any unfinished features. -5. Test and fix any problems found. Apply fixes to both master and release-X. -6. If you have willing testers for release candidates, tag X.0rc1 in the release-X branch (generally use signed annotated tags, i.e. ``git tag -sa X.0rc1``), have it build, and point testers there. Iterate over the previous points with new release candidates if necessary. -7. Tag X.0 in the release-X branch, build it, and copy its packages to ``main`` channel. -8. Mint a new DOI from Zenodo and update the README/introduction. -9. Update the m-labs.hk/artiq/manual redirect to point to m-labs.hk/artiq/manual-release-X (edit /artiq/.htaccess). -10. "Draft a new release" and close the milestone on GitHub. - -Minor (bugfix) releases ------------------------ - -1. Backport bugfixes from the master branch or fix bugs specific to old releases into the currently maintained release-X branch(es). -2. When significant bugs have been fixed, tag X.Y+1. -3. To help dealing with regressions, no new features or refactorings should be implemented in release-X branches. Those happen in the master branch, and then a new release-X+1 branch is created. -4. "Draft a new release" and close the milestone on GitHub.