search

JuliaRegistries / RegistryCI.jl

Continuous integration (CI) tools for Julia package registries, including registry consistency testing, automatic merging (automerge) of pull requests, and automatic TagBot triggers
https://juliaregistries.github.io/RegistryCI.jl/stable
Other
31 stars 30 forks source link

Declarative configuration files for configuring AutoMerge and auto-generating documentation #412

Open ericphanson opened 3 years ago

ericphanson commented 3 years ago

Transferred from https://github.com/JuliaRegistries/General/pull/36875#issuecomment-843032031

One option would be to auto-generate the docs for General as well. E.g. use Documenter instead of having a long README. And in the Documenter docs, we'd auto-generate the list of automerge guidelines.

If we did want to go this route, we could maybe do something so that you don't need to repeat/sync-up settings between AutoMerge.run to actually run the automerge and between the docs. It would be cool to have all checks be individually configurable, maybe with Preferences.jl, and then have a docs script that reads those preferences and generates the appropriate docs for the registry (for General or for any other registry). And of course AutoMerge.run would use those preferences too, to choose which checks to apply.

I think the other benefit of Preferences is that we wouldn't need to have a zillion keyword arguments to AutoMerge.run or thread them through everywhere, since we could just read them in the function that needs to decide which checks to apply.

MarkNahabedian commented 1 year ago

Issues like https://github.com/JuliaRegistries/RegistryCI.jl/issues/438, what suggest that there are workflows that use RegistryCI.AutoMerge but want to control various parameters and even which guidelines are checked rfom their registration workflows.