Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
ericphanson opened this issue May 18, 2021 · 1 comment

Comments

@ericphanson
Copy link
Member

Transferred from JuliaRegistries/General#36875 (comment)


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.

@DilumAluthge DilumAluthge changed the title Autogenerate some registry docs? Declarative configuration files for configuring AutoMerge and auto-generating documentation May 20, 2021
@MarkNahabedian
Copy link
Contributor

Issues like #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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants