Skip to content

Commit

Permalink
Merge pull request #125 from lsst/tickets/DM-30653
Browse files Browse the repository at this point in the history
DM-30653: Add v22 changes and enable towncrier
  • Loading branch information
timj committed Jun 10, 2021
2 parents 82f2559 + ce53f3f commit 0b1b9ba
Show file tree
Hide file tree
Showing 8 changed files with 102 additions and 2 deletions.
4 changes: 4 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## Checklist

- [ ] ran Jenkins
- [ ] added a release note for user-visible changes to `doc/changes`
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.
19 changes: 19 additions & 0 deletions doc/lsst.ctrl.mpexec/CHANGES.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Multi-Processing Executor v22.0 2021-04-01
==========================================

New Features
------------

* ``pipetask run`` can now execute a subset of a graph. This allows a single graph file to be created with an entire workflow and then only part of it to be executed. This is very important for large scale workflow execution. [DM-27667]

Performance Enhancement
-----------------------

* Multi-processing execution performance has been significantly improved for large graphs. [DM-28418]

Other
-----

* Ignore ``--input`` instead of rejecting it if it hasn't changed. [DM-28101]
* The graph file format has been changed from a pickle file to a form that can efficiently be accessed from an object store. This new format has a ``.qgraph`` file extension. [DM-27784]
* A full URI can now be used to specify the location of the quantum graph. [DM-27682]
11 changes: 9 additions & 2 deletions doc/lsst.ctrl.mpexec/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,15 @@ lsst.ctrl.mpexec
.. toctree linking to topics related to using the module's APIs.
.. .. toctree::
.. :maxdepth: 1
.. _lsst.ctrl.mpexec-changes:

Changes
=======

.. toctree::
:maxdepth: 1

CHANGES.rst

.. _lsst.ctrl.mpexec-contributing:

Expand Down
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 0b1b9ba

Please sign in to comment.