Stream: coq-community devs & users

Topic: How to properly use coq-community/templates

Théo Winterhalter (Feb 07 2022 at 12:32):

Hi, sorry if this was asked before but I couldn't find it.
I am slightly puzzled by how one should take advantage of coq-community/templates. This seems really cool but I don't know if I should add it as a submodule to my project or just have the meta.yml file and then use the templates scripts locally, pushing only the auto-generated github workflow for instance.

Karl Palmskog (Feb 07 2022 at 12:35):

I'm personally averse to Git submodules, so I just keep meta.yml in the repo and regenerate the files like README.md now and then (using the .mustache files from the master branch of the template repo) and check in and push the results

Théo Winterhalter (Feb 07 2022 at 12:38):

Yeah, I didn't really want to use a submodule either. Most examples don't seem to include instructions on how to regenerate them. I was wondering if it would make sense to have an explicit dependency on templates to generate the files.
For instance, one could imagine having a Github Action that pulls from template and then generates the actual action from meta.yml and run it (I have no idea if it makes sense).

Théo Winterhalter (Feb 07 2022 at 12:38):

Thanks!

Karl Palmskog (Feb 07 2022 at 12:41):

if you want more automation, then sure, you could probably set up a dependency on the templates repo. However, there are still edge cases where one might want to deviate from programmatically using all templates all the time. That's one reason we don't use that kind of workflow generally.

Théo Winterhalter (Feb 07 2022 at 12:42):

Ok. I'll stick to manually deriving them from time to time then.

Théo Winterhalter (Feb 07 2022 at 15:46):

Is there any way not to generate the README?

Théo Winterhalter (Feb 07 2022 at 15:47):

Besides listing the files I want.

Karl Palmskog (Feb 07 2022 at 15:48):

not to my knowledge, unless you hack generate.sh... I personally tend to update files one-by-one anyway...

Théo Winterhalter (Feb 07 2022 at 15:50):

Ok. Thanks again.

Last updated: Sep 25 2023 at 14:01 UTC