DM-30291: Initial configuration of towncrier

.github/pull_request_template.md

@@ -0,0 +1,4 @@
+## Checklist
+
+- [ ] ran Jenkins
+- [ ] added a release note for user-visible changes to `doc/changes`

doc/changes/DM-27241.feature.rst

@@ -0,0 +1 @@
+Add a new ``butler retrieve-artifacts`` command to copy file artifacts from a Butler datastore.

doc/changes/DM-28678.other.rst

@@ -0,0 +1 @@
+Enable serialization of ``DatasetRef`` and related classes to JSON format.

doc/changes/DM-30140.perf

@@ -0,0 +1 @@
+Make collection and dataset pruning significantly more efficient.

doc/changes/DM-30291.misc.md

@@ -0,0 +1 @@
+Change release note creation to use [Towncrier](https://towncrier.readthedocs.io/en/actual-freaking-docs/index.html).

doc/changes/README.rst

@@ -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.

doc/changes/datastore/DM-29849.perf

@@ -0,0 +1 @@
+FileDatastore: Improve removing of datasets from the trash by at least a factor of 10.

doc/changes/registry/DM-29196.feature

@@ -0,0 +1,3 @@
+Support UUIDs as the primary keys in registry and allow for reproducible UUIDs.
+
+This change will significantly simplify transferring of data between butler repositories.

doc/changes/registry/DM-30200.feature.rst

@@ -0,0 +1 @@
+Allow registry methods such as ``queryDatasets`` to use a glob-style string when specifying collection or dataset type names.

pyproject.toml

@@ -0,0 +1,55 @@
+[tool.towncrier]
+    package = "lsst.daf.butler"
+    package_dir = "python"
+    filename = "doc/lsst.daf.butler/CHANGES.rst"
+    directory = "doc/changes"
+    title_format = "Butler {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
+
+    [[tool.towncrier.section]]
+        name = ""
+        path = ""
+
+    [[tool.towncrier.section]]
+        name = "Butler Datastores"
+        path = "datastore"
+
+    [[tool.towncrier.section]]
+        name = "Butler Registry"
+        path = "registry"