From 342339e9b7e67c3ef0eafa1dfd14f4a3f10134d1 Mon Sep 17 00:00:00 2001 From: Valentin Gatien-Baron Date: Mon, 3 Feb 2025 02:55:18 +0100 Subject: [PATCH] bistro: stop publishing docs There is little reason to publish docs to github, considering ocaml.org already makes api docs available. Changing this behavior allows setting the opam doc field to any url without dune-release choking on it. Maybe it'd be preferable to delete the docs publishing code entirely? --- CHANGES.md | 3 +++ bin/bistro.ml | 10 +++++----- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 4aaa78df..933cca13 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -6,6 +6,9 @@ - Use the 'user' option as the fork owner, only attempt to decode the remote URL if the user option is not set. (#480, @Julow) +- `dune-release bistro` no longer publishes docs to github pages. Instead, we rely on + the docs published under `ocaml.org/packages`. + ### Deprecated ### Fixed diff --git a/bin/bistro.ml b/bin/bistro.ml index 53d0b962..8d9b8943 100644 --- a/bin/bistro.ml +++ b/bin/bistro.ml @@ -22,7 +22,7 @@ let bistro () (`Dry_run dry_run) (`Package_names pkg_names) ~skip_lint ~skip_build ~skip_tests ~include_submodules () >! fun () -> Publish.publish ~token ~pkg_names ~version ~tag ~keep_v ~dry_run - ~publish_artefacts:[] ~yes:false ~draft () + ~publish_artefacts:[ `Distrib ] ~yes:false ~draft () >! fun () -> Opam.get_pkgs ~dry_run ~keep_v ~tag ~pkg_names ~version () >>= fun pkgs -> Opam.pkg ~dry_run ~pkgs () >! fun () -> @@ -43,10 +43,10 @@ let man = `S Manpage.s_description; `P "The $(tname) command (quick in Russian) is equivalent to invoke:"; `Pre - "dune-release distrib # Create the distribution archive\n\ - dune-release publish # Publish it to Github with its documentation\n\ - dune-release opam pkg # Create an opam package\n\ - dune-release opam submit # Submit it to OCaml's opam repository"; + "dune-release distrib # Create the distribution archive\n\ + dune-release publish distrib # Publish it to Github\n\ + dune-release opam pkg # Create an opam package\n\ + dune-release opam submit # Submit it to OCaml's opam repository"; `P "See dune-release(7) for more information."; ]