Run Pkg.update on Manifest.toml files before PR about compathelper.jl HOT 8 CLOSED

I’m not 100% sure I understand why this is necessary.

Why not check in test/Project.toml instead of test/Manifest.toml, docs/Project.toml instead of docs/Manifest.toml, and benchmark/Project.toml instead of benchmark/Manifest.toml.

And then, in those Project.toml files, either don’t have any compat entries, or if you do have compat entries, make them of the form >= x.y.z.

Then the test, docs, benchmark projects will automatically use the latest versions of their dependencies.

The only reason that the CompatHelper.jl bot is necessary is because we strongly recommend having upper-bounded compat entries in your package’s main Project.toml file. We don’t have a similar recommendation for the test, docs, benchmark projects, so I don’t think you needed upper-bounded compat entries in those projects.

from compathelper.jl.

You need to check in subproject manifests {test,docs,benchmark}/Manifest.toml if

• you are using non-registered packages as dependencies
• you want reproducible test, documentation build, and benchmarks

OK, technically, I can write a build script for each subproject to achieve those goals. But it'd be great if I don't have to re-implement what Pkg already does.

from compathelper.jl.

I guess this is doable. CompatHelper would cd into the docs folder and run julia --project -e 'import Pkg; Pkg.instantiate(); Pkg.update()'. And then repeat that for all of the folders.

You would provide a vector ["test", "docs", "benchmark"] to let me know which projects you want me to update.

from compathelper.jl.

That sounds great. Or maybe even add another API CompatHelper.main(precommit_hook) so that I can just do

run: |-
  julia -e '
  using CompatHelper
  CompatHelper.main() do
      run(`julia --project=test -e 'import Pkg; Pkg.instantiate(); Pkg.update()'`)
      run(`julia --project=docs -e 'import Pkg; Pkg.instantiate(); Pkg.update()'`)
  end
  '

and you can avoid dealing with similar feature requests?

from compathelper.jl.

Not a terrible idea

from compathelper.jl.

@tkf Can you try the feature out?

from compathelper.jl.

@tkf It would be great to add a section to the README documenting the precommit_hook feature. Would you be willing to write up a brief explanation, along with the example YAML snippet? And make a PR?

from compathelper.jl.

I'll send a PR 👍

from compathelper.jl.