hiro/releases
1
0
Fork 0
mirror of https://github.com/vale981/releases synced 2025-03-06 02:01:41 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

DDD re combining keywords and specs

Browse source
This commit is contained in:
Jeff Forcier 2016-04-28 18:55:05 -07:00
parent 64daa56cfc
commit 7f6dd57533
2 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/concepts.rst
View file

@ -339,6 +339,10 @@ use one you're familiar with from packaging systems like
* To be clear, **you may put any combination of major+minor version number in * To be clear, **you may put any combination of major+minor version number in
these annotations**, just as with the simpler ``(1.5+)`` style format. these annotations**, just as with the simpler ``(1.5+)`` style format.
* This is mostly applicable to bugs or backported issues. Features, support
items and major bugs only need to inform Releases about major release
lines.
Armed with this more powerful syntax, we can limit some issues just to the 1.x Armed with this more powerful syntax, we can limit some issues just to the 1.x
line:: line::

6
docs/usage.rst
View file

@ -89,6 +89,12 @@ Specifically:
``(N.N+)`` allowing annotation of issues belonging to specific major ``(N.N+)`` allowing annotation of issues belonging to specific major
versions. versions.
.. note::
It is possible to give *both* a regular keyword
(``backported``/``major``) *and* a spec (``(N.N+)``/``(>=1.0)``) in
the same issue. However, giving two keywords or two specs at the same
time makes no sense & is not allowed.
* Regular Sphinx content may be given after issue roles and will be preserved * Regular Sphinx content may be given after issue roles and will be preserved
as-is when rendering. For example, in ``:bug:`123` Fixed a bug, thanks as-is when rendering. For example, in ``:bug:`123` Fixed a bug, thanks
`@somebody`!``, the rendered changelog will preserve/render "Fixed a bug, `@somebody`!``, the rendered changelog will preserve/render "Fixed a bug,