Start working on getting rid of unreleased.rst

Document new process in CONTRIBUTING.md, .github/pull_request_template.md and unreleased.rst (for good measure) Report the previous changelog additions here so that they're not lost in the mist of times. CHANGELOG_BEGIN - [DAML Stdlib] Added the ``NumericScale`` typeclass, which improves the type inference for Numeric literals, and helps catch the creation of out-of-bound Numerics earlier in the compilation process. - [DAML Triggers] ``emitCommands`` now accepts an additional argument that allows you to mark contracts as pending. Those contracts will be automatically filtered from the result of ``getContracts`` until we receive the corresponding completion/transaction. - [Navigator] Fixed a bug where Navigator becomes unresponsive if the ledger does not contain any DAML packages. - [Ledger-API] Add field ``gen_map`` in Protobuf definition for ledger api values. This field is used to support generic maps, an new feature currently in development. See issue #3356 for more details about generic maps. The Ledger API will send no messages where this field is set, when using a stable version of DAML-LF. However the addition of this field may cause pattern-matching exhaustive warnings in the code of ledger API clients. Those warnings can be safely ignored until GenMap is made stable in an upcoming version of DAML-LF. - [JSON API - Experimental] CLI configuration to enable serving static content as part of the JSON API daemon: ``--static-content "directory=/full/path,prefix=static"`` This configuration is NOT recommended for production deployment. See issue #2782. - [Extractor] The app can now work against a Ledger API server that requires client authentication. See `issue #3157 <https://github.com/digital-asset/daml/issues/3157>`__. - [DAML Script] This release contains a first version of an experimental DAML script feature that provides a scenario-like API that is run against an actual ledger. - [DAML Compiler] The default DAML-LF version is now 1.7. You can still produce DAML-LF 1.6 by passing ``--target=1.6`` to ``daml build``. - [JSON API - Experimental] The database schema has changed; if using ``--query-store-jdbc-config``, you must rebuild the database by adding ``,createSchema=true``. See `issue #3461 <https://github.com/digital-asset/daml/pull/3461>`_. - [JSON API - Experimental] Terminate process immediately after creating schema. See issue #3386. - [DAML Stdlib] ``fromAnyChoice`` and ``fromAnyContractKey`` now take the template type into account. CHANGELOG_END
digital-asset · Nov 20, 2019 · 3ffd921 · 3ffd921
1 parent f94b832
commit 3ffd921
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 2 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -4,7 +4,7 @@
 - [ ] Include appropriate tests
 - [ ] Set a descriptive title and thorough description
 - [ ] Add a reference to the [issue this PR will solve](https://github.com/digital-asset/daml/issues), if appropriate
-- [ ] Add a line to the [release notes](https://github.com/digital-asset/daml/blob/master/unreleased.rst), if appropriate
+- [ ] Include changelog additions in one or more commit message bodies, if appropriate
 - [ ] Normal production system change, include purpose of change in description
 
 NOTE: CI is not automatically run on non-members pull-requests for security

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -30,7 +30,15 @@ For Git commit messages, our principle is that `git log --pretty=oneline` should
 - Does your PR include appropriate tests?
 - Make sure your PR title and description makes it easy for other developers to understand what the contained commits do. The title should say what the changes do. The description should expand on what it does (if not obvious from the title alone), and say why it is being done.
 - If your PR corresponds to an issue, add “Fixes #XX” to your pull request description. This will auto-close the corresponding issue when the commit is merged into master and tie the PR to the issue.
-- If your PR includes user-facing changes, you must add a line describing the change to [unreleased.rst](unreleased.rst) as part of your PR. Each entry in this document must start with the component to which is belongs, as in the following example:
+- If your PR includes user-facing changes, one or more commits in the PR must end their body with a paragraph titled ``CHANGELOG`` that includes relevant changelog entries, where each entry starts with the component to which is belongs in square brackets. Use RST to format links as this text will be added to the changelog upon release.
+
+The following is an example of a well-formed commit, including the description (first line) and a body that includes changelog additions:
+
+      Fixes #1311
+
+      Also fixes a typo in the Scala bindings documentation.
+
+      CHANGELOG
 
       - [Sandbox] Introduced a new API for package management.
         See `#1311 <https://github.com/digital-asset/daml/issues/1311>`__.

diff --git a/unreleased.rst b/unreleased.rst
@@ -50,3 +50,21 @@ HEAD — ongoing
 
 - [DAML Stdlib] ``fromAnyChoice`` and ``fromAnyContractKey`` now take
   the template type into account.
+WARNING: THIS FILE IS NO LONGER USED AND WILL SOON BE DELETED!
+
+Changelog additions must now be added to the end of one or more commit message bodies in a PR.
+
+The following is an example of a commit message including a description and a body that includes changelog additions:
+
+.. code-block:: none
+
+  Fixes #1311
+
+  Also fixes a typo in the Scala bindings documentation.
+
+  CHANGELOG
+
+  - [Sandbox] Introduced a new API for package management.
+    See `#1311 <https://github.com/digital-asset/daml/issues/1311>`__.
+
+Please check `CONTRIBUTING.MD <https://github.com/digital-asset/daml/blob/master/CONTRIBUTING.md#pull-request-checklist>`__ for more details.