search

jbrunton / gflows

A CLI tool that makes templating GitHub Workflows easy
MIT License
30 stars 3 forks source link

Update documentation on libs usage in config.yml #180

Closed ghost closed 3 years ago

ghost commented 3 years ago

Thanks a lot for a great tool!

In the documentation, the yml for "libs" property should be 

templates: 
  defaults: 
    libs:
    - my-lib

Now it is missing the "defaults" field. We can find the proper example in tests.

Don't know how to raise a PR for wiki, sorry for that.

jbrunton commented 3 years ago

@andrey-covergo: Thanks very much for the heads up! I will make the change and double check the docs.

jbrunton commented 3 years ago

I updated the docs. Thanks for the issue!

ghost commented 3 years ago

Thanks a lot @jbrunton!

I was surprised by the quality of your tool, it just works after you understand how to use it. You can peek at how we use it. Can we use private repositories for GFlows packages?

jbrunton commented 3 years ago

@andrey-covergo: thanks for the feedback! It would be very useful to support private repos for packages. I opened #185 with some thoughts on how this could work. Could you take a look and let me know what you think?

EDIT: actually, I realize I need to think through this case a little further (as there are a few different use cases: local; CI using the setup-gflows action; possibly CI without using setup-gflows). I'll try to outline a more thorough proposal later today.

EDIT 2: OK, drafted a proposal which I'm happy with. Feedback welcome.