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

Generator contract - how to write my own generator #975

Open
vlcinsky opened this issue Mar 20, 2023 · 2 comments
Open

Generator contract - how to write my own generator #975

vlcinsky opened this issue Mar 20, 2023 · 2 comments
Labels

Comments

@vlcinsky
Copy link
Contributor

Describe the bug/feature
I did not find a description about how to write a generator. The only source of information I have are generators within kapitan-refrence repository.

To Reproduce
Try to find a documentation or tutorial about authoring generator.

Expected behavior
The documentation shall clarify things such as:

  • what file(s) to write to create a generator
  • how to configure a target to use given generator
  • required functions within the generator module (probably main) incl. signature (probably expecting input_params dictionary with function key)
  • where the content of input_params comes from
  • return value of the main function and how it is used. Does it allow creation of multiple files at once as jsonnet does? (by using keys with filenames).
@MatteoVoges
Copy link
Contributor

Hey @vlcinsky ,
I will work on some improvements to the generators and their documentation soon. I would be happy if you can let me know if my solution meets all of your requirements.

Your listed wishes/questions will be taken into account!

@github-actions
Copy link

github-actions bot commented Oct 2, 2023

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@github-actions github-actions bot added the Stale label Oct 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants