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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃挕 How to inject json summary in template engine (gomplate) 馃挕 #31

Open
9 tasks
adriens opened this issue Mar 15, 2022 · 3 comments
Open
9 tasks
Assignees
Labels
BUILD enhancement New feature or request help wanted Extra attention is needed
Projects

Comments

@adriens
Copy link
Member

adriens commented Mar 15, 2022

馃憠 Context

Actually the --jsonsummary makes it possible to get the summary as a valid json output :

image

So it can be queried for further integrations thanks to jq for example.

馃挕 The idea

The main idea is to extend yamlfixer by plugging it to a template engine so people can inject yamlfixer in a great variety of tools. The main idea consists on delivering ready to use gomplate templates, as part of the GH repo.

I thought about following outputs :

  • yaml
  • html
  • csv
  • markdown (?... as yaml already is very explicit)

馃殌 Actions

Thanks to gomplate template engine :

  • Create a dedicated directory dedicated to gomplate templates (gomplates)
  • Create the template that output yaml
  • Create the template that output html
  • Create the template that output csv
  • Provide scripts that show a real use case for all of them
  • Update the Katacoda scenario to showcase how yamlfixer can be plugged with gomplate
  • Make de short demo in video 鈻讹笍 @adriens
  • Make a short DEV.to post showcasing this feature 鈻讹笍 @adriens
  • Tweet about the DEV.to post 鈻讹笍 @adriens (and tag @hairyhenderson)
@tamere-allo-peter
Copy link
Member

@adriens : please use yamlfixer v0.3.2 or higher to replace the above screenshot.

@adriens adriens added the enhancement New feature or request label Mar 15, 2022
@adriens adriens added this to Candidates in yamlfixer via automation Mar 15, 2022
@adriens adriens moved this from Candidates to To do in yamlfixer Mar 15, 2022
@adriens adriens pinned this issue Mar 15, 2022
@adriens
Copy link
Member Author

adriens commented Mar 15, 2022

@mbarre we need your skills on gomplate 馃檹

@adriens adriens added the help wanted Extra attention is needed label Mar 15, 2022
@adriens
Copy link
Member Author

adriens commented Mar 15, 2022

@tamere-allo-peter :

@adriens : please use yamlfixer v0.3.2 or higher to replace the above screenshot.

Done 馃憤

@adriens adriens added the BUILD label Apr 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BUILD enhancement New feature or request help wanted Extra attention is needed
Projects
Development

No branches or pull requests

3 participants