From 0bbed9bcb6f05ac858b6a20db43e99c124ee087b Mon Sep 17 00:00:00 2001 From: Robert Jordens Date: Mon, 25 Jan 2016 17:04:33 -0700 Subject: [PATCH] RELEASING.rst, doc: show release notes in manual --- RELEASES | 25 ------------------------- RELEASE_NOTES.rst | 9 +++++++++ RELEASING.rst | 17 +++++++++++++++++ doc/manual/index.rst | 1 + doc/manual/introduction.rst | 1 + doc/manual/release_notes.rst | 1 + 6 files changed, 29 insertions(+), 25 deletions(-) delete mode 100644 RELEASES create mode 100644 RELEASE_NOTES.rst create mode 100644 RELEASING.rst create mode 100644 doc/manual/release_notes.rst diff --git a/RELEASES b/RELEASES deleted file mode 100644 index f66711bc9..000000000 --- a/RELEASES +++ /dev/null @@ -1,25 +0,0 @@ -Release process -=============== - -Maintain the release notes in this file with a list of new features and API changes in each major release. - -Major releases: -1. Create branch release-X from master. -2. Remove any unfinished features. -3. Test and fix any problems found. -4. Tag X.0. - -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. - - -Release notes -============= - -1.0 ---- -* First release -* Experiments (your code) should use ``from artiq.experiment import *`` - (and not ``from artiq import *`` as previously) diff --git a/RELEASE_NOTES.rst b/RELEASE_NOTES.rst new file mode 100644 index 000000000..fc8f26d92 --- /dev/null +++ b/RELEASE_NOTES.rst @@ -0,0 +1,9 @@ +Release notes +============= + +1.0 +--- + + * First release + * Experiments (your code) should use ``from artiq.experiment import *`` + (and not ``from artiq import *`` as previously) diff --git a/RELEASING.rst b/RELEASING.rst new file mode 100644 index 000000000..dc32f7b7c --- /dev/null +++ b/RELEASING.rst @@ -0,0 +1,17 @@ +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. Remove any unfinished features. + 3. Test and fix any problems found. + 4. Tag X.0. + +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. diff --git a/doc/manual/index.rst b/doc/manual/index.rst index f13e79a3e..57f3d0a0f 100644 --- a/doc/manual/index.rst +++ b/doc/manual/index.rst @@ -8,6 +8,7 @@ Contents: introduction installing + release_notes getting_started_core getting_started_mgmt core_device diff --git a/doc/manual/introduction.rst b/doc/manual/introduction.rst index a538c3980..fd7a58f99 100644 --- a/doc/manual/introduction.rst +++ b/doc/manual/introduction.rst @@ -4,6 +4,7 @@ Introduction .. this does not work because of relative paths for the logo: .. include:: ../../README.rst and including in README.rst does not work on github + therefore just keep this content synchronized with README.rst ARTIQ (Advanced Real-Time Infrastructure for Quantum physics) is a next-generation control system for quantum information experiments. It is diff --git a/doc/manual/release_notes.rst b/doc/manual/release_notes.rst new file mode 100644 index 000000000..764448b9c --- /dev/null +++ b/doc/manual/release_notes.rst @@ -0,0 +1 @@ +.. include:: ../../RELEASE_NOTES.rst