forked from M-Labs/artiq
RELEASING.rst, doc: show release notes in manual
This commit is contained in:
parent
893ffb04c9
commit
0bbed9bcb6
25
RELEASES
25
RELEASES
|
@ -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)
|
|
|
@ -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)
|
|
@ -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.
|
|
@ -8,6 +8,7 @@ Contents:
|
||||||
|
|
||||||
introduction
|
introduction
|
||||||
installing
|
installing
|
||||||
|
release_notes
|
||||||
getting_started_core
|
getting_started_core
|
||||||
getting_started_mgmt
|
getting_started_mgmt
|
||||||
core_device
|
core_device
|
||||||
|
|
|
@ -4,6 +4,7 @@ Introduction
|
||||||
.. this does not work because of relative paths for the logo:
|
.. this does not work because of relative paths for the logo:
|
||||||
.. include:: ../../README.rst
|
.. include:: ../../README.rst
|
||||||
and including in README.rst does not work on github
|
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
|
ARTIQ (Advanced Real-Time Infrastructure for Quantum physics) is a
|
||||||
next-generation control system for quantum information experiments. It is
|
next-generation control system for quantum information experiments. It is
|
||||||
|
|
|
@ -0,0 +1 @@
|
||||||
|
.. include:: ../../RELEASE_NOTES.rst
|
Loading…
Reference in New Issue