Merge #214

214: Update example r=DilumAluthge a=ericphanson Closes #212 Co-authored-by: Eric P. Hanson <[email protected]>
JuliaRegistries · Jun 3, 2020 · 93b13f2 · 93b13f2 · DilumAluthge · Jun 3, 2020
2 parents e381ff9 + 56646ef
commit 93b13f2
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "CompatHelper"
 uuid = "aa819f21-2bde-4658-8897-bab36330d9b7"
 authors = ["Dilum Aluthge <[email protected]>", "Brown Center for Biomedical Informatics"]
-version = "1.9.0"
+version = "1.9.1"
 
 [deps]
 Base64 = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f"

diff --git a/README.md b/README.md
@@ -164,9 +164,13 @@ A full example is available [here](https://github.com/tkf/Kaleido.jl/blob/42f812
 The following snippet tells CompatHelper to update the `Manifest.toml` file in the root of the repository but not any of the other `Manifest.toml` files. So, for example, `/Manifest.toml` will be updated, but `/docs/Manifest.toml`, `/examples/Manifest.toml`, and `/test/Manifest.toml` will not be updated.
 
 ```yaml
-run: julia -e 'using CompatHelper; CompatHelper.main( (; registries) -> CompatHelper._update_manifests(pwd(); registries = registries) )'
+run: julia -e 'using CompatHelper; CompatHelper.main( (; registries) -> CompatHelper._update_manifests(String[pwd()]; registries = registries, delete_old_manifests = true) )'
 ```
 
+If the keyword argument `delete_old_manifests` is set to true, as in the above example, then CompatHelper
+updates the Manifest.toml file by deleting the Manifest and running `Pkg.update()` in order to generate a new
+one. If `delete_old_manifests=false`, then CompatHelper runs `Pkg.update()` without first deleting the Manifest.
+
 ### 2.4. Overriding the default branch
 
 By default, CompatHelper will open pull requests against your repository's default branch. If you would like to override this behavior, set the `master_branch` keyword argument. For example: