Skip to content

Commit

Permalink
Enable towncrier
Browse files Browse the repository at this point in the history
  • Loading branch information
timj committed Jun 8, 2021
1 parent 71be9a3 commit cb01764
Show file tree
Hide file tree
Showing 5 changed files with 70 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/changes/DM-28649.feature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
``pipetask qgraph`` can now generate a standalone "execution butler" which is a SQLite registry with all the expected outputs pre-filled in registry. Using this registry allow ``pipetask run`` to execute without touching the main registry whilst still writing file artifacts to the standard location. It is not yet configured to allow a completely detached processing using a local datastore but this can be changed manually after creation to use a chained datastore.
1 change: 1 addition & 0 deletions doc/changes/DM-29384.bugfix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improve exception handling in ``ExecFixupDataId``
1 change: 1 addition & 0 deletions doc/changes/DM-29580.bugfix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix config comparison with ``--skip-existing``.
24 changes: 24 additions & 0 deletions doc/changes/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Recording Changes
=================

This directory contains "news fragments" which are small files containing text that will be integrated into release notes.
The files can be in restructured text format or plain text.

Each file should be named like ``<JIRA TICKET>.<TYPE>`` with a file extension defining the markup format.
The ``<TYPE>`` should be one of:

* ``feature``: New feature
* ``bugfix``: A bug fix.
* ``api``: An API change.
* ``perf``: A performance enhancement.
* ``doc``: A documentation improvement.
* ``removal``: An API removal or deprecation.
* ``other``: Other Changes and Additions of interest to general users.
* ``misc``: Changes that are of minor interest.

An example file name would therefore look like ``DM-30291.misc.rst``.

If the change concerns specifically the registry or a datastore the news fragment can be placed in the relevant subdirectory.

You can test how the content will be integrated into the release notes by running ``towncrier --draft --version=V.vv``.
``towncrier`` can be installed from PyPI or conda-forge.
43 changes: 43 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
[tool.towncrier]
package = "lsst.ctrl.mpexec"
package_dir = "python"
filename = "doc/lsst.ctrl.mpexec/CHANGES.rst"
directory = "doc/changes"
title_format = "Multi-Processing Executor {version} {project_date}"
issue_format = "`{issue} <https://jira.lsstcorp.org/browse/{issue}>`_"


[[tool.towncrier.type]]
directory = "feature"
name = "New Features"
showcontent = true

[[tool.towncrier.type]]
directory = "api"
name = "API Changes"
showcontent = true

[[tool.towncrier.type]]
directory = "bugfix"
name = "Bug Fixes"
showcontent = true

[[tool.towncrier.type]]
directory = "perf"
name = "Performance Enhancement"
showcontent = true

[[tool.towncrier.type]]
directory = "other"
name = "Other Changes and Additions"
showcontent = false

[[tool.towncrier.type]]
directory = "misc"
name = "Miscellaneous Changes of Minor Interest"
showcontent = false

[[tool.towncrier.type]]
directory = "removal"
name = "An API Removal or Deprecation"
showcontent = false

0 comments on commit cb01764

Please sign in to comment.