daml/unreleased.rst

24 lines
822 B
ReStructuredText
Raw Normal View History

.. Copyright (c) 2020 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
Move unreleased user-facing features to its own file (#1762) * Move unreleased user-facing features to its own file docs/source/support/release-notes.rst unfortunately represents a "global lock" when it comes to submitting contributions: if another contribution changed it while another was going through the CI/review process, the latter would have to go again through the CI build after resolving the conflict and merging the resulting commit. The contributors originally tried to address this problem by letting the system automatically performing this operation, but this failed because release notes were moved to the wrong section by mistake. This simple change would allow the contributors to let the system take care of merging on its own, because existing release notes will no longer be corrupted by the process. There is a caveat: the automatic merging could result in invalid RST (mostly because of missing newlines). This would push the task of ensuring the release notes are valid RST to the release. I would argue this can be done quite easily and that this is checked automatically when rendering RST to HTML, so it could be a nuisance during release but it would make the day-to-day contributions easier. * Address https://github.com/digital-asset/daml/pull/1762#issuecomment-503540993 * Address https://github.com/digital-asset/daml/pull/1762#pullrequestreview-251676158 * Address https://github.com/digital-asset/daml/pull/1762#discussion_r295279530 * Remove HEAD section from release-notes.rst * Address https://github.com/digital-asset/daml/pull/1762#pullrequestreview-251678791 * Address https://github.com/digital-asset/daml/pull/1762#issuecomment-503549896
2019-06-19 17:32:03 +03:00
.. SPDX-License-Identifier: Apache-2.0
Remove unreleased.rst (#3547) * 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 https://github.com/digital-asset/daml/pull/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 * Document new release process to gather changelog additions * Change the release script to ignore unreleased.rst * Remove spurious unreleased.rst lines * Transition to use tags * Document new way to get changelog additions with tags * Update release/RELEASE.md Co-Authored-By: Gary Verhaegen <gary.verhaegen@digitalasset.com> * Address https://github.com/digital-asset/daml/pull/3547#discussion_r348438786 * Document correction process * Add copyright header to unreleased.sh * Update CONTRIBUTING.md Co-Authored-By: Gary Verhaegen <gary.verhaegen@digitalasset.com> * Modify CONTRIBUTING.md after @garyverhaegen-da's proposal * Make unreleased.sh run per commit and treat tags as case-insensitive * Fix documentation for replacements
2019-11-20 18:16:57 +03:00
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_BEGIN
- [Sandbox] Introduced a new API for package management.
See `#1311 <https://github.com/digital-asset/daml/issues/1311>`__.
CHANGELOG_END
Please check `CONTRIBUTING.MD <https://github.com/digital-asset/daml/blob/master/CONTRIBUTING.md#pull-request-checklist>`__ for more details.