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

Generate the configuration.md file automatically on changes to the configuration code. #2524

Open
t4lz opened this issue Jun 13, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@t4lz
Copy link
Member

t4lz commented Jun 13, 2024

I think it would be nicest if we could have the patch automatically pushed to main after a commit with changes to the config is merged into main.

If we're afraid of automatically pushing to main, we could maybe push into a PR's branch instead, once it's created and has changes to the config crate.

The weakest option would be to just regenerate that file and require it not to be different, like we do with the json schema, forcing contributors to regenerate that file manually when needed.

Depending on what strategy we choose, this might be combined with metalbear-co/mirrord.dev#207.

@infiniteregrets
Copy link
Contributor

pushing to main doesnt sound good, id rather think of doing a check on each pr if mirrord/config/ has been changed and the job should fail. this weak check imo is more flexible... and perhaps having a pre commit hook makes sense here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants