Add flag to validate change log

Author: gridbugs

CHANGES.md

@@ -2,6 +2,9 @@
 
 ### Added
 
+- Add flag to `dune-release check` that attempts to discover and parse the
+  change log. (#458, @gridbugs)
+
 ### Changed
 
 ### Deprecated

bin/check.ml

@@ -15,7 +15,7 @@ let clone_and_checkout_tag repo ~dir ~tag =
 let check (`Package_names pkg_names) (`Package_version version) (`Dist_tag tag)
     (`Keep_v keep_v) (`Build_dir build_dir) (`Skip_lint skip_lint)
     (`Skip_build skip_build) (`Skip_tests skip_tests)
-    (`Working_tree on_working_tree) =
+    (`Check_change_log check_change_log) (`Working_tree on_working_tree) =
   (let dir, clean_up =
      if on_working_tree then (OS.Dir.current (), fun _ -> ())
      else
@@ -46,7 +46,7 @@ let check (`Package_names pkg_names) (`Package_version version) (`Dist_tag tag)
    Config.keep_v ~keep_v >>= fun keep_v ->
    let check_result =
      Check.check_project ~pkg_names ?tag ?version ~keep_v ?build_dir ~skip_lint
-       ~skip_build ~skip_tests ~dir ()
+       ~skip_build ~skip_tests ~check_change_log ~dir ()
    in
    let () = clean_up dir in
    check_result)
@@ -80,7 +80,7 @@ let term =
   Term.(
     const check $ Cli.pkg_names $ Cli.pkg_version $ Cli.dist_tag $ Cli.keep_v
     $ Cli.build_dir $ Cli.skip_lint $ Cli.skip_build $ Cli.skip_tests
-    $ working_tree)
+    $ Cli.check_change_log $ working_tree)
 
 let info = Cmd.info "check" ~doc ~man
 let cmd = Cmd.v info term

bin/cli.ml

@@ -256,6 +256,12 @@ let skip_tests =
   in
   named (fun x -> `Skip_tests x) Arg.(value & flag & info [ "skip-tests" ] ~doc)
 
+let check_change_log =
+  let doc = "Check that the change log can be parsed" in
+  named
+    (fun x -> `Check_change_log x)
+    Arg.(value & flag & info [ "check-change-log" ] ~doc)
+
 let keep_build_dir =
   let doc =
     "Keep the distribution build directory after successful archival."

bin/cli.mli

@@ -105,6 +105,9 @@ val skip_build : [> `Skip_build of bool ] Term.t
 val skip_tests : [> `Skip_tests of bool ] Term.t
 (** a [--skip-test] option to skip checking the tests *)
 
+val check_change_log : [> `Check_change_log of bool ] Term.t
+(** a [--check-change-log] option to force validation of change-log *)
+
 val keep_build_dir : [> `Keep_build_dir of bool ] Term.t
 (** a [--keep-build-dir] flag to keep the build directory used for the archive
     check. *)

lib/check.ml

@@ -88,8 +88,11 @@ let dune_project_check dir =
   in
   R.join @@ Sos.with_dir ~dry_run:false dir check ()
 
-let check_project ~pkg_names ~skip_lint ~skip_build ~skip_tests ?tag ?version
-    ~keep_v ?build_dir ~dir () =
+let change_log_check pkg =
+  Pkg.change_log pkg >>= Text.change_log_file_last_entry >>| Fun.const 0
+
+let check_project ~pkg_names ~skip_lint ~skip_build ~skip_tests
+    ~check_change_log ?tag ?version ~keep_v ?build_dir ~dir () =
   match pkg_creation_check ?tag ?version ~keep_v ?build_dir dir with
   | Error (`Msg err) ->
       App_log.report_status `Fail (fun m -> m "%s" err);
@@ -102,5 +105,8 @@ let check_project ~pkg_names ~skip_lint ~skip_build ~skip_tests ?tag ?version
       >>= fun dune_exit ->
       (if skip_lint then Ok 0
       else Lint.lint_packages ~dry_run:false ~dir ~todo:Lint.all pkg pkg_names)
-      >>| fun lint_exit ->
+      >>= fun lint_exit ->
+      (if check_change_log then change_log_check pkg else Ok 0)
+      >>| fun change_log_exit ->
       opam_file_exit + dune_project_exit + dune_exit + lint_exit
+      + change_log_exit

lib/check.mli

@@ -16,6 +16,7 @@ val check_project :
   skip_lint:bool ->
   skip_build:bool ->
   skip_tests:bool ->
+  check_change_log:bool ->
   ?tag:Vcs.Tag.t ->
   ?version:Version.t ->
   keep_v:bool ->