OCaml Changelog

Added

• Support for OCaml 4.13 (#330, @emillon)

Additions

• Compatibility with OCaml 4.13 (ocaml/odoc#699, @Octachron)

Added

• Display OCaml warnings in mdx-error blocks (#293, @gpetiot)

Fixed

• Show exceptions in the correct order (#332, @talex5)

Added

• Add --no-auto-open to the default command. It was previously only available for dune-release opam. (#374, @NathanReb)
• Add a config create subcommand to create a fresh configuration if you don't have one yet (#373, @NathanReb)
• Add --local-repo, --remote-repo and --opam-repo options to the default command, they used to be only available for the opam subcommand (#363, @NathanReb)
• Add a --token option to dune-release publish and dune-release opam commands to specify a github token. This allows dune-release to be called through a Github Actions workflow and use the github token through an environment variable. (#284 #368, @gpetiot @NathanReb)
• Log curl calls on verbose/debug mode (#281, @gpetiot)
• Try to publish the release asset again after it failed (#272, @gpetiot)
• Improve error reporting of failing git comands (#257, @gpetiot)
• Suggest a solution for users without ssh setup (#304, @pitag-ha)
• Allow including git submodules to the distrib tarball by passing the --include-submodules flag to dune-release, dune-release bistro or dune-release distrib (#300, @NathanReb)
• Support 'git://' scheme for dev-repo uri (#331, @gpetiot)
• Support creation of draft releases and draft PRs. Define a new option --draft for dune-release publish and dune-release opam submit commands. (#248, @gpetiot)
• Add a new command check to check the prerequisites of dune-release and avoid starting a release process that couldn't be finished (#318, #351, @pitag-ha)
• When preparing the opam-repository PR and pushing the local branch to the user's remote opam-repository fork, use --set-upstream to ease any further update of the PR (#350, @gpetiot)

Changed

• Entirely rely on the remote fork of opam-repository URL in opam submit instead of reading the user separately. The information was redundant and could only lead to bugs when unproperly set. (#372, @NathanReb)
• Use pure token authentication for Github API requests rather than "token as passwords" authentication (#369, @NathanReb)
• Require tokens earlier in the execution of commands that use the github API. If the token isn't saved to the user's configuration, the prompt for creating one will show up at the command startup rather than on sending the first request (#368, @NathanReb)
• Attach the changelog to the annotated tag message (#283, @gpetiot)
• Do not remove versioned files from the tarball anymore. We used to exclude .gitignore, .gitattributes and other such files from the archive. (#299, @NathanReb)
• Don't try to push the tag if it is already present and point to the same ref on the remote. dune-release must guess which URI to pass to git push and may guess it wrong. This change allows users to push the tag manually to avoid using that code. (#219, @Julow)
• Don't try to create the release if it is already present and points to the same tag (#277, @kit-ty-kate)
• Recursively exclude all .git/.hg files and folders from the distrib tarball (#300, @NathanReb)
• Make the automatic dune-release workflow to stop if a step exits with a non-zero code (#332, @gpetiot)
• Make git-related mdx tests more robust in unusual environments (#334, @sternenseemann)
• Set the default tag message to "Release " instead of "Distribution "
• Opam file linter: check for synopsis instead of description (#291, @kit-ty-kate)
• Upgrade the use of the opam libraries to opam 2.1 (#343, @kit-ty-kate)

Deprecated

• Deprecate the --user CLI options and configuration field, they were redundant with the remote-repo option and field and could be set unproperly, leading to bugs (#372, @NathanReb)
• Deprecate the use of delegates in dune-release publish (#276, #302, @pitag-ha)
• Deprecate the use of opam file format 1.x (#352, @NathanReb)

Removed

• Option --name is removed from all commands. When used with dune-release distrib, it was previously effectively ignored. Now it is required to add a (name <name>) stanza to dune-project. (#327, @lehy)

Fixed

• Fix a bug where opam submit would look up a config file, even though all the required information was provided on the command line. This would lead to starting the interactive config creation quizz if that file did not exist which made it impossible to use it in a CI for instance. (#373, @NathanReb)
• Fix a bug where opam submit would fail on non-github repositories if the user had no configuration file (#372, @NathanReb)
• Fix a bug where subcommands wouldn't properly read the token files, leading to authentication failures on API requests (#368, @NathanReb)
• Fix a bug in opam submit preventing non-github users to create the opam-repo PR via dune-release. (#359, @NathanReb)
• Fix a bug where opam submit would try to parse the custom URI provided through --distrib-uri as a github repo URI instead of using the dev-repo (#358, @NathanReb)
• Fix the priority of the --distrib-uri option in dune-release opam pkg. It used to have lower precedence than the url file written by dune-release publish and therefore made it impossible to overwrite it if needed. (#255, @NathanReb)
• Fix a bug with --distrib-file in dune-release opam pkg where you would need the regular dune-release generated archive to be around even though you specified a custom distrib archive file. (#255, @NathanReb)
• Use int64 for timestamps. (#261, @gpetiot)
• Define the order of packages (#263, @gpetiot)
• Allow the dry-run mode to continue even after some API call's response were expected by using placeholder values (#262, @gpetiot)
• Build and run tests for all selected packages when checking distribution tarball (#266, @NathanReb)
• Improve trimming of the changelog to preserve the indentation of the list of changes. (#268, @gpetiot)
• Trim the data of the url file before filling the url.src field. This fixes an issue that caused the url.src field to be a multi-line string instead of single line. (#270, @gpetiot)
• Fix a bug causing dune-release to exclude all hidden files and folders (starting with .) at the repository from the distrib archive (#298, @NathanReb)
• Better report GitHub API errors, all of the error messages reported by the GitHub API are now checked and reported to the user. (#290, @gpetiot)
• Fix error message when dune-release tag cannot guess the project name (#319, @lehy)
• Always warn about uncommitted changes at the start of dune-release distrib (#325, @lehy). Otherwise uncommitted changes to dune-project would be silently ignored by dune-release distrib.
• Fix rewriting of github references in changelog (#330, @gpetiot)
• Fixes a bug under cygwin where dune-release was unable to find the commit hash corresponding to the release tag (#329, @gpetiot)
• Fixes release names by explicitly setting it to match the released version (#338, @NathanReb)
• Fix a bug that prevented release of a package whose version number contains invalid characters for a git branch. The git branch names are now sanitized. (#271, @gpetiot)
• publish: Fix the process of inferring user name and repo from the dev repo uri (#348, @pitag-ha)

• Added an '--output-patch' option to allow use without a Github account
• Use the latest opam libraries (2.1.0~rc) with better format-preserving printing
• Avoid submission of packages without a reachable archive, except if --force was set or they are conf packages

• Add (enabled_if ...) to (mdx ...) (https://github.com/ocaml/dune/pull/4434, @emillon)

• Add support for instrumentation dependencies (https://github.com/ocaml/dune/pull/4210, fixes https://github.com/ocaml/dune/issues/3983, @nojb)

• Add the possibility to use locks with the cram tests stanza (https://github.com/ocaml/dune/pull/4480, @voodoos)

• Allow to set up merlin in a variant of the default context (https://github.com/ocaml/dune/pull/4145, @TheLortex, @voodoos)

• Add (package ...) to (mdx ...) (https://github.com/ocaml/dune/pull/4691, fixes https://github.com/ocaml/dune/issues/3756, @emillon)

• Handle renaming of coq.kernel library to coq-core.kernel in Coq 8.14 (https://github.com/ocaml/dune/pull/4713, @proux01)

• Fix generation of merlin configuration when using (include_subdirs unqualified) on Windows (https://github.com/ocaml/dune/pull/4745, @nojb)

• Fix bug for the install of Coq native files when using (include_subdirs qualified) (https://github.com/ocaml/dune/pull/4753, @ejgallego)

• Allow users to specify install target directories for doc and etc sections. We add new options --docdir and --etcdir to both Dune's configure and dune install command. (https://github.com/ocaml/dune/pull/4744, fixes https://github.com/ocaml/dune/issues/4723, @ejgallego, thanks to @JasonGross for reporting this issue)

• Fix issue where Dune would ignore (env ... (coq (flags ...))) declarations appearing in dune files (https://github.com/ocaml/dune/pull/4749, fixes https://github.com/ocaml/dune/issues/4566, @ejgallego @rgrinberg)

• Disable some warnings on Coq 8.14 and (lang coq (>= 0.3)) due to the rework of the Coq "native" compilation system (https://github.com/ocaml/dune/pull/4760, @ejgallego)

• Fix a bug where instrumentation flags would be added even if the instrumentatation was disabled (@nojb, https://github.com/ocaml/dune/pull/4770)

• Fix https://github.com/ocaml/dune/issues/4682: option -p takes now precedence on environement variable DUNE_PROFILE (https://github.com/ocaml/dune/pull/4730, https://github.com/ocaml/dune/pull/4774, @bobot, reported by @dra27 https://github.com/ocaml/dune/issues/4632)

• Fix installation with opam of package with dune sites. The .install file is now produced by a local dune install during the build phase (https://github.com/ocaml/dune/pull/4730, https://github.com/ocaml/dune/pull/4645, @bobot, reported by @kit-ty-kate https://github.com/ocaml/dune/issues/4198)

• Fix multiple issues in the sites feature (https://github.com/ocaml/dune/pull/4730, https://github.com/ocaml/dune/pull/4645 @bobot, reported by @Lelio-Brun https://github.com/ocaml/dune/issues/4219, by @Kakadu https://github.com/ocaml/dune/issues/4325, by @toots https://github.com/ocaml/dune/issues/4415)

Features

• Add sub-errors as "related" information in diagnostics (#457)

• Add support for navigating to a symbol inside a workspace (#398)

• Show typed holes as errors

  Merlin has a concept of "typed holes" that are syntactically represented as _. Files that incorporate typed holes are not considered valid OCaml, but Merlin and OCaml-LSP support them. One example when such typed holes can occur is when on "destructs" a value, e.g., destructing (Some 1) will generate code match Some 1 with Some _ -> _ | None -> _. While the first underscore is a valid "match-all"/wildcard pattern, the rest of underscores are typed holes.

• If the current working directory is the home directory, then do not load .ocamlinit (@hyphenrf @copy #338)
• With OCaml 4.12.0 and later, the toplevel uses the toplevel state to exit with the right status code (#348 @octachron)
• Fix color highlight for errors (#350 @chripell)
• Add support for OCaml 4.13 (#353 @kit-ty-kate)

Emacs mode fixes:

• Company text-completion fixes (@leungbk #340)
• utop-query-arguments always returns (utop-arguments) whether it sets the utop-command or not (@dansanduleac #347)
• Fix completion returning bogus candidates (#352 @chripell @rgrinberg)

Added

• Add a new dune-gen subcommand that generates testing code for Dune to build and run with the new mdx stanza. (#305, @voodoos)

Fixes

• Switch verbosity from 1 to 0. This is the same default that merlin uses. The old value for verbosity (#433)

• Get fresh diagnostics (warning and error messages) on a file save (#438)

  Note: If you want the fresh diagnostics to take into account changes in other files, you likely need to rebuild your project. An easy way to get automatic rebuilds is to run dune in a watching mode, e.g.,[dune build --watch].

Features

• Code action to annotate a value with its type (#397)

Fixes

• Fix interface/implementation switching on Windows (#427)

• Correctly parse project paths with spaces and other special characters that must be escaped.

• Print types with -short-paths even if the project wasn't built yet

• merlin binary
  • external configuration reading:
    • use relative paths to communicate with Dune when possible. This solves issues related to symlinks on Unix and improve Windows support (#1271, fixes #1288)
    • make the workdir configuration value when using the dune ocaml-merlin configuration provider the same as when using dot-merlin-reader so that ppxes behaves in the same way as before (#1284, fixes ocaml/dune#4479, discussion in #1292)
  • destruct:
    • improve prefixing of generated constructors in Destruct by filtering opened modules (#1277)
    • make the destruct command more resilient to ill-typed expressions and when called without nodes (#1304, fixes #1300)
  • reintroduce some record recovery and improve completion (#1276)
  • introduce a new AST node for holes (_), allow correct typing of these holes and add a new holes command that returns the locations of all holes in the current file along with their types (#1242, #1289)
  • Mppx: don't restore cookies after invocation. Ppx are invoked only once so there is no need to manage cookies. This small change should increase performance and should not change any other behavior (#1309)
  • Windows: system command variant: do not open a window console when launching a ppx (#1270, fixes #714)
  • fix same file documentation bug (#1265 by @ulugbekna, fixes #1261)
• editor modes
  • vim: Add MerlinNextHole and MerlinPreviousHole commands to navigate between holes. Jump to the first hole after destruct (#1287, #1303)
  • emacs: Add merlin-next-hole and merlin-previous-hole commands to navigate holes. Jump to the first hole after calling destruct. (#1291)
  • emacs: modernization of the elisp code and conformance with coding guidelines (#1247, #1310 by Steve Purcell )
  • vim & emacs : new client-side "merlin use package" commands, restoring previous behavior (#1272, fixes #1191)
• test suite
  • cover constructor disambiguation and record fields (#1276)
  • cover the new holes command and AST node (#1242, #1289)
  • cover the document fix (#1265, #1315)

Oops, we went looking but didn't find the changelog for this release 🙈

Bug fixes

• Fix extraneous parenthesis after let open with closing-on-separate-line (#1612, @Julow)
• Add missing break between polytype quantification and arrow-type body (#1615, @gpetiot)

Changes

• Use dune instrumentation backend for bisect_ppx (#1550, @tmattio)
• Format objects and classes consistently with structure and signature items (#1569, @bikallem)

New features

• Expose a RPC interface through a new binary ocamlformat-rpc and a new library ocamlformat-rpc-lib (#1586, @gpetiot, @voodoos)

• Support 4.12 and drop support for all earlier versions

• Update to the latest version of merlin

• Fixed absence of executable bit for installed .cmxs (#4149, fixes #4148, @bobot)

• Fix a race in Dune cache. It was particularly easy to hit this race when using the cache on Windows (#4406, fixes #4167, @snowleopard)

Fixes

• Backport fixes from merlin (#382, #383)

• Encode request & notification params in a list. This is required by the spec. (#351)

• Make patdiff show refined diffs (#4257, fixes #4254, @hakuch)

• Fixed a bug that could result in needless recompilation under Windows due to case differences in the result of Sys.getcwd (observed under emacs). (#3966, @nojb).

• Restore compatibility with Coq < 8.10 for coq-lang < 0.3 , document that (using coq 0.3) does require Coq 8.10 at least (#4224, fixes #4142, @ejgallego)

• Add a META rule for compiler-libs.native-toplevel (#4175, @altgr)

• No longer call chmod on symbolic links (fixes #4195, @dannywillems)

• Have dune communicate the location of the standard library directory to merlin (#4211, fixes #4188, @nojb)

• Workaround incorrect exception raised by Unix.utimes (OCaml PR#8857) in Path.touch on Windows. This fixes dune cache in direct mode on Windows. (#4223, @dra27)

• dune ocaml-merlin is now able to provide configuration for source files in the _build directory. (#4274, @voodoos)

• Automatically delete left-over Merlin files when rebuilding for the first time a project previously built with Dune <= 2.7. (#4261, @voodoos, @aalekseyev)

• Fix ppx.exe being compiled for the wrong target when cross-compiling (#3751, fixes #3698, @toots)

• dune top correctly escapes the generated toplevel directives, and make it easier for dune top to locate C stubs associated to concerned libraries. (#4242, fixes #4231, @nojb)

• Do not pass include directories containing native objects when compiling bytecode (#4200, @nojb)

• Fix crash when META file for compiler-libs.toplevel is present (@jeremiedimino, #4249)

Removed

• Remove the 'let-open' option, deprecated since 0.16.0 (#1563, @gpetiot)
• Remove support for OCaml 4.06 and 4.07, minimal version requirement bumped to OCaml 4.08 (#1549, @gpetiot)
• Remove the 'extension-sugar' option, deprecated since 0.14.0 (#1588, @gpetiot)

Bug fixes

• Fix parsing of invalid file wrt original source handling (#1542, @hhugo)
• Preserve the syntax of infix set/get operators (#1528, @gpetiot). String.get and similar calls used to be automatically rewritten to their corresponding infix form .(), that was incorrect when using the -unsafe compilation flag. Now the concrete syntax of these calls is preserved.
• Add location of invalid docstring in warning messages (#1529, @gpetiot)
• Fix comments on the same line as prev and next elements (#1556, @gpetiot)
• Break or-patterns after comments and preserve their position at the end of line (#1555, @gpetiot)
• Fix linebreak between signature items of the same group (#1560, @gpetiot)
• Fix stack overflow on large string constants (#1562, @gpetiot)
• Fix comment position around list cons operator (#1567, @gpetiot)
• Fix the vertical alignment test to break down comment groups (#1575, @gpetiot)
• Preserve spacing of toplevel comments (#1554, @gpetiot)
• Support more sugared extension points (#1587, @gpetiot)

Changes

• Add buffer filename in the logs when applying ocamlformat (#1557, @dannywillems)
• Improve comment position in pattern collection (#1576, @gpetiot)
• Consistent positioning of lambda return type annotations when no-break-infix-before-func and pre/post extensions (#1581, @gpetiot)

New features

• Support injectivity type annotations (OCaml 4.12 feature) (#1523, @gpetiot)

• ocaml support Detailed list of changes on https://tarides.com/blog/2021-01-26-recent-and-upcoming-changes-to-merlin#dropping-support-for-old-versions-of-ocaml Summary:
  • any revision of Merlin now only supports one version of OCaml. Support for other versions will be found in other branches
  • stopped actively supporting version older than 4.11
  • add support for 4.12
• merlin binary
  • add keyword completion (disabled by default) (#1243)
  • fix a bug which caused type-enclosing to sometimes look at an incorrect node (#1232, fixes #1226)
  • properly report leaked parsing error (#1223, fixes #1222)
  • wrap merlin_analysis and merlin_utils library
  • fix windows paths canonicalization (#1254)
  • fix hanging on windows (#1256, #1263)
• editor modes
  • emacs: add missing mandatory argument for define-obsolete-function-alias (#1250, by Atharva Shukla, fixes #1234)
  • emacs: use "opam var" instead of "opam config var" (#1249, by Raja Boujbel)
  • vim: fix CursorMoved semantics (#1213, by @ddickstein)
  • vim: add :MerlinLocateImpl and :MerlinLocateIntf (#1208 by Matthew Ryan)
• test suite
  • replace mdx usage by dune's cram mechanism

Changed

• Dropped OMP dependency and use handwritten compat layers instead (#317, @NathanReb)

• Fixed wrong workspace discovery from dune ocaml-merlin (#4127, fixes #4125, @voodoos)

• Fixed memory blow up introduced in 2.8.0 (#4144, fixes #4134, @jeremiedimino)

• Configurator: always link the C libraries in the build command (#4088, @MisterDA).

Added

• Allow to explicitly set the kind of blocks in labels: ocaml, cram, toplevel or include. (#237, @gpetiot)
• Include blocks do not require an empty block anymore (#286, @gpetiot)
• Support for OCaml 4.12 (#298, @kit-ty-kate)

Changed

• Improve error message of cram test exceptions due to empty lines in a block (#270, @pitag-ha)

Fixed

• Report #require directive errors (#276, @gpetiot)
• Handle no such file exception: the input file and the values of options --root and --prelude are checked (#292, @gpetiot)
• Keep locations from parsing instead of recomputing the lines, providing better error messages (#241, @gpetiot)
• Use create_process instead of execvp to call mdx-test from mdx. This fixes running mdx from dune on Windows (#299, @emillon)

• Fixed dune --version printing n/a rather than the version

• dune rules accepts aliases and other non-path rules (#4063, @mrmr1993)

• Action (diff reference test_result) now accept reference to be absent and in that case consider that the reference is empty. Then running dune promote will create the reference file. (#3795, @bobot)

• Ignore special files (BLK, CHR, FIFO, SOCKET), (#3570, fixes #3124, #3546, @ejgallego)

• Experimental: Simplify loading of additional files (data or code) at runtime in programs by introducing specific installation sites. In particular it allow to define plugins to be installed in these sites. (#3104, #3794, fixes #1185, @bobot)

• Move all temporary files created by dune to run actions to a single directory and make sure that actions executed by dune also use this directory by setting TMPDIR (or TEMP on Windows). (#3691, fixes #3422, @rgrinberg)

• Fix bootstrap script with custom configuration. (#3757, fixes #3774, @marsam)

• Add the executable field to inline_tests to customize the compilation flags of the test runner executable (#3747, fixes #3679, @lubegasimon)

• Add (enabled_if ...) to (copy_files ...) (#3756, @nojb)

• Make sure Dune cleans up the status line before exiting (#3767, fixes #3737, @alan-j-hu)

• Add {gitlab,bitbucket} as options for defining project sources with source stanza (source (<host> user/repo)) in the dune-project file. (#3813, @rgrinberg)

• Fix generation of META and dune-package files when some targets (byte, native, dynlink) are disabled. Previously, dune would generate all archives for regardless of settings. (#3829, #4041, @rgrinberg)

• Do not run ocamldep to for single module executables & libraries. The dependency graph for such artifacts is trivial (#3847, @rgrinberg)

• Fix cram tests inside vendored directories not being interpreted correctly. (#3860, fixes #3843, @rgrinberg)

• Add package field to private libraries. This allows such libraries to be installed and to be usable by other public libraries in the same project (#3655, fixes #1017, @rgrinberg)

• Fix the %{make} variable on Windows by only checking for a gmake binary on UNIX-like systems as a unrelated gmake binary might exist on Windows. (#3853, @kit-ty-kate)

• Fix $ dune install modifying the build directory. This made the build directory unusable when $ sudo dune install modified permissions. (fix #3857, @rgrinberg)

• Fix handling of aliases given on the command line (using the @ and @@ syntax) so as to correctly handle relative paths. (#3874, fixes #3850, @nojb)

• Allow link time code generation to be used in preprocessing executable. This makes it possible to use the build info module inside the preprocessor. (#3848, fix #3848, @rgrinberg)

• Correctly call git ls-tree so unicode files are not quoted, this fixes problems with dune subst in the presence of unicode files. Fixes #3219 (#3879, @ejgallego)

• dune subst now accepts common command-line arguments such as --debug-backtraces (#3878, @ejgallego)

• dune describe now also includes information about executables in addition to that of libraries. (#3892, #3895, @nojb)

• instrumentation backends can now receive arguments via (instrumentation (backend <name> <args>)). (#3906, #3932, @nojb)

• Tweak auto-formatting of dune files to improve readability. (#3928, @nojb)

• Add a switch argument to opam when context is not default. (#3951, @tmattio)

• Avoid pager when running $ git diff (#3912, @AltGr)

• Add (root_module ..) field to libraries & executables. This makes it possible to use library dependencies shadowed by local modules (#3825, @rgrinberg)

• Allow (formatting ...) field in (env ...) stanza to set per-directory formatting specification. (#3942, @nojb)

• [coq] In coq.theory, :standard for the flags field now uses the flags set in env profile flags (#3931 , @ejgallego @rgrinberg)

• [coq] Add -q flag to :standard coqc flags , fixes #3924, (#3931 , @ejgallego)

• Add support for Coq's native compute compilation mode (@ejgallego, #3210)

• Add a SUFFIX directive in .merlin files for each dialect with no preprocessing, to let merlin know of additional file extensions (#3977, @vouillon)

• Stop promoting .merlin files. Write per-stanza Merlin configurations in binary form. Add a new subcommand dune ocaml-merlin that Merlin can use to query the configuration files. The allow_approximate_merlin option is now useless and deprecated. Dune now conflicts with merlin < 3.4.0 and ocaml-lsp-server < 1.3.0 (#3554, @voodoos)

• Configurator: fix a bug introduced in 2.6.0 where the configurator V1 API doesn't work at all when used outside of dune. (#4046, @aalekseyev)

• Fix libexec and libexec-private variables. In cross-compilation settings, they now point to the file in the host context. (#4058, fixes #4057, @TheLortex)

• When running $ dune subst, use project metadata as a fallback when package metadata is missing. We also generate a warning when (name ..) is missing in dune-project files to avoid failures in production builds.

• Remove support for passing -nodynlink for executables. It was bypassed in most cases and not correct in other cases in particular on arm32. (#4085, fixes #4069, fixes #2527, @emillon)

• Generate archive rules compatible with 4.12. Dune longer attempt to generate an archive file if it's unnecessary (#3973, fixes #3766, @rgrinberg)

• Fix generated Merlin configurations when multiple preprocessors are defined for different modules in the same folder. (#4092, fixes #2596, #1212 and #3409, @voodoos)

• Add the option use_standard_c_and_cxx_flags to dune-project that 1. disables the unconditional use of the ocamlc_cflags and ocamlc_cppflags from ocamlc -config in C compiler calls, these flags will be present in the :standard set instead; and 2. enables the detection of the C compiler family and populates the :standard set of flags with common default values when building CXX stubs. (#3875, #3802, fix #3718 and #3528, @voodoos)

• Drop Github token generation feature, no longer supported by Github API.
• Use newer github library, avoiding warning with deprecated authentication method
• Allow publication of packages without URL (for conf packages)
• Added flag --no-browser to disable browser popup
• Fix detection of package names when specifying opam file names on the command-line

• add support for OCaml 4.12 (@emillon, #339)

Features

• Support cancellation notifications when possible. (#323)

• Implement signature help request for functions (#324)

• Server LSP requests & notifications concurrently. Requests that require merlin are still serialized. (#330)

Features

• Code action to insert inferred module interface (#308)

• Filter keywords by context (#307)

Features

• Add keyword completion

• Add go to declaration functionality to jump to a value's specification in a .mli file (#294)

Fixes

• #245: correctly use mutexes on OpenBSD (#264)

• #268: Do not use vendored libraries when building the lsp package (#260)

• #271: Clear diagnostics when files are closed

• Disable non-prefix completion. There's no reliably way to trigger it and it can be slow.

Removed

• Remove the 'escape-chars' option, deprecated since 0.14.0 (#1462, @gpetiot)
• Remove the 'escape-strings' option, deprecated since 0.14.0 (#1463, @gpetiot)
• Remove the 'doc-comments-val' option, deprecated since 0.14.2 (#1461, @gpetiot)
• Removed options are now listed in the commandline manual (new REMOVED OPTIONS section) (#1469, @Julow)

Changes

• Set 'indicate-multiline-delimiters=no' on default profile (#1452, @gpetiot)
• Option 'let-open' is now deprecated, concrete syntax will always be preserved starting from OCamlFormat v0.17.0, corresponding to the current 'let-open=preserve' behavior. (#1467, @gpetiot)
• Warnings printed by ocamlformat itself now use the 4.12 style with symbolic names (#1511, #1518, @emillon)
• Remove extension from executable name in error messages. On Windows, this means that messages now start with "ocamlformat: ..." instead of "ocamlformat.exe: ..." (#1531, @emillon)
• Using tokens instead of string manipulation when inspecting the original source (#1526, #1533, #1541 @hhugo) (#1532, @gpetiot)

Bug fixes

• Allow a break after if%ext with if-then-else=keyword-first (#1419, #1543, @gpetiot)
• Fix parentheses around infix applications having attributes (#1464, @gpetiot)
• Fix parentheses around the index arg of a non-sugared index operation (#1465, @gpetiot)
• Preserve comment position around match and try keywords (#1458, @gpetiot)
• Add missing break in module statement (#1431, @gpetiot)
• Indent attributes attached to included modules better (#1468, @gpetiot)
• Clean up ocamlformat.el for submission to MELPA (#1476, #1495, @bcc32)
  • Added missing package metadata to ocamlformat.el (#1474, @bcc32)
  • Fix ocamlformat.el buffer replacement for MacOS Emacs (#1481, @juxd)
• Add missing parentheses around a pattern matching that is the left-hand part of a sequence when an attribute is attached (#1483, @gpetiot)
• Add missing parentheses around infix operator used to build a function (#1486, @gpetiot)
• Fix comments around desugared expression (#1487, @gpetiot)
• Fix invalid fragment delimiters of format-invalid-files recovery mode (#1485, @hhugo)
• Fix misalignment of cases in docked function match (#1498, @gpetiot)
• Preserve short-form extensions for structure item extensions (#1502, @gpetiot). For example open%ext M will not get rewritten to [%%ext open M].
• Do not change the spaces within the code spans in docstrings (#1499, @gpetiot)
• Comments of type constrained label in record pattern have to be relocated in 4.12 (#1517, @gpetiot)
• Preserve functor syntax for OCaml 4.12 (#1514, @gpetiot)
• Fix inconsistencies of the closing parentheses with indicate-multiline-delimiters (#1377, #1540, @gpetiot)
• Fix position of comments around list constructor (::) (#1524, @gpetiot)
• Fix comments position in extensions (#1525, @gpetiot)
• Fix formatting of field override with constraint (#1544, @gpetiot)

• merlin binary
  • simplify local store implementation and API (#1188, #1184)
  • fix a destruct issue allowing ill-typed match completions (#1194)

Additions

• Compatibility with OCaml 4.12 (ocaml/odoc#531, @Octachron)

Internal

• Use ppxlib instead of ocaml-migrate-parsetree 1.x. (#1482, @emillon)
  • No functional changes are expected.
  • Cherry picked commits: 219dc1e3a4614041e1bc5428d003c0af4e, 9e453b0ef87124e33827ee2423289deef8, 7ad1e575ffa4ce3022c71daba39954d3b9, eb49db6772a9adabe611982000465d0ad7, dc79052a085950cd88fdef0843f665a029, c06c544e21bd65b726cde8fee0f78a6248, ce94d2fa50ff276b5782070375a0b30ba1

• dot-merlin-reader
  • fix issue when multiple packages with pxxes are declared in the configuration. (#1181, fixes #1179)

• merlin binary
  • fix completion of pattern matchings with exception patterns (#1169)
  • delegate configuration reading to external programs via a simple protocol and create a new package dot-merlin-reader with a binary that reads .merlin files. (#1123, #1152)

• configurator: More flexible probing of #define. We allow duplicate values in the object file, as long as they are the same after parsing. (#3739, fixes #3736, @rgrinberg)

• Record instrumentation backends in dune-package files. This makes it possible to use instrumentation backends defined in installed libraries (eg via OPAM). (#3735, @nojb)

• Add missing .aux & .glob targets to coq rules (#3721, fixes #3437, @rgrinberg)

• Fix dune-package installation when META templates are present (#3743, fixes #3746, @rgrinberg)

• Resolve symlinks before running $ git diff (#3750, fixes #3740, @rgrinberg)

• Cram tests: when checking that all test directories contain a run.t file, skip empty directories. These can be left around by git. (#3753, @emillon)

Oops, we went looking but didn't find the changelog for this release 🙈

• merlin binary
  • dune: restore compatibility with dune 1.8.0 (#1157, #1153)

• ocaml support
  • full support from OCaml 4.02 to OCaml 4.11 (#1153)

• Write intermediate files in a .mdx folder for each mdx stanza to prevent the corresponding actions to be executed as part of the @all alias (#3659, @NathanReb)

• Read Coq flags from env (#3547 , fixes #3486, @gares)

• Allow bisect_ppx to be enabled/disabled via dune-workspace. (#3404, @stephanieyou)

• Formatting of dune files is now done in the executing dune process instead of in a separate process. (#3536, @nojb)

• Add a --debug-artifact-substution flag to help debug problem with version not being captured by dune-build-info (#3589, @jeremiedimino)

• Allow the use of the context_name variable in the enabled_if fields of executable(s) and install stanzas. (#3568, fixes #3566, @voodoos)

• Fix compatibility with OCaml 4.12.0 when compiling empty archives; no .a file is generated. (#3576, @dra27)

• $ dune utop no longer tries to load optional libraries that are unavailable (#3612, fixes #3188, @anuragsoni)

• Fix dune-build-info on 4.10.0+flambda (#3599, @emillon, @jeremiedimino).

• Allow multiple libraries with inline_tests to be defined in the same directory (#3621, @rgrinberg)

• Run exit hooks in jsoo separate compilation mode (#3626, fixes #3622, @rgrinberg)

• Add (alias ...), (mode ...) fields to (copy_fields ...) stanza (#3631, @nojb)

• (copy_files ...) now supports copying files from outside the workspace using absolute file names (#3639, @nojb)

• Dune does not use ocamlc as an intermediary to call C compiler anymore. Configuration flags ocamlc_cflags and ocamlc_cppflags are always prepended to the compiler arguments. (#3565, fixes #3346, @voodoos)

• Revert the build optimization in #2268. This optimization slows down building individual executables when they're part of an executables stanza group (#3644, @rgrinberg)

• Use {dev} rather than {pinned} in the generated .opam file. (#3647, @kit-ty-kate)

• Insert correct extension name when editing dune-project files. Previously, dune would just insert the stanza name. (#3649, fixes #3624, @rgrinberg)

• Fix crash when evaluating an mdx stanza that depends on unavailable packages. (#3650, @CraigFe)

• Fix typo in cache-check-probablity field in dune config files. This field now requires 2.7 as it wasn't usable before this version. (#3652, @edwintorok)

• Add "odoc" {with-doc} to the dependencies in the generated .opam files. (#3667, @kit-ty-kate)

• Do not allow user actions to capture dune's stdin (#3677, fixes #3672, @rgrinberg)

• (subdir ...) stanzas can now appear in dune files used via (include ...). (#3676, @nojb)

Changes

• Do not break inline elements such as {i blah} in docstrings (#1346, @jberdine)
• Distinguish hash-getter from hash-comparison infix operators. Operators of the form #**# or #**. where ** can be 0 or more operator chars are considered getter operators and are not surrounded by spaces, as opposed to regular infix operators (#1376, @gpetiot)
• Type constraint on return type of functions is now always printed before the function body (#1381, #1397, @gpetiot)

Bug fixes

• Restore previous functionality for pre-post extension points (#1342, @jberdine)
• Fix extra break before function body of a fun (#1343, @jberdine)
• Indent further args of anonymous functions (#1440, @gpetiot)
• Do not clear the emacs *compilation* buffer on successful reformat (#1350, @jberdine)
• Fix disabling with attributes on OCaml < 4.08 (#1322, @emillon)
• Preserve unwrapped comments by not adding artificial breaks when wrap-comments=false and ocp-indent-compat=true are set to avoid interfering with ocp-indent indentation. (#1352, @gpetiot)
• Break long literal strings at the margin (#1367, @gpetiot)
• Break after a multiline argument in an argument list (#1360, @gpetiot)
• Remove unnecessary parens around object (#1379, @gpetiot)
• Fix placement of comments on constants (#1383, @gpetiot)
• Do not escape arguments of some Odoc tags (#1391, 1408, @gpetiot, @Julow). The characters []{} must not be escaped in the arguments of @raise, @author, @version and others.
• Fix missing open line between multi-line let-binding with poly-typexpr (#1372, @jberdine)
• Remove trailing space after expression when followed by an attribute and break before attributes attached to multi-line phrases (#1382, @gpetiot)
• Do not add a space to minimal comments (* *), (** *) and (*$ *) (#1407, @gpetiot)
• Fix attributes position in labelled arguments type (#1434, @gpetiot)
• Add missing parens around type annotation in anonymous function (#1433, @gpetiot)
• Fix alignment of 'then' keyword in parenthesised expression (#1421, @gpetiot)

New features

• Support quoted extensions (added in ocaml 4.11) (#1405, @gpetiot)
• Recognise eliom file extensions (#1430, @jrochel)

• Fix compatibility with OCaml 4.12 (#3585, fixes #3583, @ejgallego)

Changes

• No functional changes from 0.14.2. The goal of this release is to be compatible with base and stdio v0.14.0.
• Backport the following PRs:
  • Update opam metadata (#1386)
  • Add compatibility with base.v0.14.0 (#1396)
  • Allow stdio.v0.14 (#1399)

Added

• HTML comments can carry block labels (#234, @gpetiot) The syntax is: <!-- $MDX labels -->, where labels is a list of valid labels separated by a comma. This line has to immediately precede the block it is attached to. The legacy syntax is preserved and will be deprecated in a later release.
• Add support for toplevel blocks in .mli files' doc comments (#206, @jsomers)
• Add support for OCaml 4.11 (#261, @kit-ty-kate)

Changed

• Apply unnamed preludes to all environments (#271, @gpetiot) New behavior:
  • env_and_file "a:f" associates f to the environment named a
  • env_and_file " :f" associates f to the default environment
  • env_and_file "f" associates f to all environments.
• Errors in non toplevel OCaml blocks are now printed to a seperate mdx-error code block following the ocaml block instead of crashing the mdx process. Those mdx-error blocks are recognized and checked by mdx and can be intentionally used to show case specific compile errors. (#238, @gpetiot)
• Improve error reporting for invalid (* $MDX part-... *) delimiters (#250, @gpetiot)

Deprecated

• The command 'mdx rule' is deprecated and will be removed in 2.0.0 (#251, @gpetiot)

Fixed

• Fix the environment selection for preludes and slightly improve quality of type names in evaluations of toplevel phrases in certain cases. (#225, @gpetiot)
• Fix toplevel parsing when phrases contain tabs (#240, @gpetiot)
• Avoid adding newlines to empty blocks (#253, @gpetiot)
• Preserve the indentation of included files (#259, @gpetiot)
• Preserve the header in shell blocks (#249, @craigfe)
• Support underscores in environment variables in set- and unset- labels (#257, @shonfeder)
• Fix mdx on Windows which was looking for the ocaml-mdx-test binary at the wrong place (#263, @hcarty)
• Properly report mdx parsing errors instead of crashing with an uncaught exception (#267, @gpetiot)

Added

• Add a dune-release config subcommand to display and edit the global configuration (#220, @NathanReb).
• Add command delegate-info to print information needed by external release scripts (#221, @pitag-ha)
• Use Curly instead of Cmd to interact with github (#202, @gpetiot)
• Add x-commit-hash field to the opam file when releasing (#224, @gpetiot)
• Add support for common alternative names for the license and ChangeLog file (#204, @paurkedal)

Changed

• Command tag: improve error and log messages by comparing the provided commit with the commit correspondent to the provided tag (#226, @pitag-ha)
• Error logs: when an external command fails, include its error message in the error message posted by dune-release (#231, @pitag-ha)
• Error log formatting: avoid unnecessary line-breaks; indent only slightly in multi-lines (#234, @pitag-ha)
• Linting step of dune-release distrib does not fail when opam's doc field is missing. Do not try to generate nor publish the documentation when opam's doc field is missing. (#235, @gpetiot)

Deprecated

• Deprecate opam 1.x (#195, @gpetiot)

Fixed

• Separate packages names by spaces in publish logs (#171, @hannesm)
• Fix uncaught exceptions in distrib subcommand and replace them with proper error messages (#176, @gpetiot)
• Use the 'user' field in the configuration before inferring it from repo URI and handles HTTPS URIs (#183, @gpetiot)
• Ignore backup files when looking for README, CHANGES and LICENSE files (#194, @gpetiot)
• Do not echo input characters when reading token (#199, @gpetiot)
• Improve the output of VCS command errors (#193, @gpetiot)
• Better error handling when checking opam version (#195, @gpetiot)
• Do not write 'version' and 'name' fields in opam file (#200, @gpetiot)
• Use Yojson to parse github json response and avoid parsing bugs. (#177, @gpetiot)
• The git command used in publish doc should check DUNE_RELEASE_GIT (even if deprecated) before PATH. (#242, @gpetiot)
• Adapt the docs to the removal of the log subcommand (#196, @gpetiot)

• Fix crash when caching is enabled (@rgrinberg, #3581, fixes #3580)

• Do not use -output-complete-exe until 4.10.1 as it is broken in 4.10.0 (@jeremiedimino, #3187)

• Fix crash when an unknown pform is found (such as %{unknown}) (#3560, @emillon)

• Improve error message when invalid package names (such as the empty string) are passed to dune build -p. (#3561, @emillon)

• Fix a stack overflow when displaying large outputs (including diffs) (#3537, fixes #2767, #3490, @emillon)

• Pass -g when compiling ppx preprocessors (#3671, @rgrinberg)

Additions

• Compatibility with OCaml 4.11 (#434, @kit-ty-kate)