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

add meta.yml and generate boilerplate from templates #32

Merged
merged 2 commits into from
Jul 24, 2024
Merged

Conversation

palmskog
Copy link
Member

@tchajed here is an attempt at using our templates to generate the boilerplate for the project as much as possible, including (opam-based) CI. The hope is that this could simplify maintenance.

What do you think?

@tchajed
Copy link
Member

tchajed commented Jul 24, 2024

I don't want to write the README in a YAML file and have it auto-generated. It's the main content of this repository and this duplicates all of it and makes contributing a bit harder. Everything else seems good to generate.

I realize some of the README is easiest to generate from the YAML, like the badges. Maybe we just manually copy those in from the generated file? We could add a dev/README.md with a reminder of how that works.

@palmskog
Copy link
Member Author

palmskog commented Jul 24, 2024

OK, I'll remove the README content from meta.yml. We can keep some of the auto-generated badge stuff (in README.md), but as-yet it will have to be manually updated in the future.

@tchajed
Copy link
Member

tchajed commented Jul 24, 2024

The opam build is a little sketchy because it doesn't use the argument customization in the Makefile. For now I think this is fine (and everything builds even without the customizations) - longer term I think we should make such tricks be in a separate directory with their own build setup. That would also be helpful for showing any examples of complete build setups.

@tchajed tchajed merged commit 0a2930a into main Jul 24, 2024
2 checks passed
@tchajed tchajed deleted the meta-ci branch July 24, 2024 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants