aws-doc-sdk-examples icon indicating copy to clipboard operation
aws-doc-sdk-examples copied to clipboard

Published 20 hours ago • verified publisher icon awsdocs

[Story]: Automate README re-generation using Jinja templates

Open ford-at-aws opened this issue 2 years ago • 2 comments

The user story

As an engineer on the code examples team, I want to be able to automate the maintenance of my README's so that (a) they remain compliant as our template changes over time, and (b) the task of updating them becomes fully automated.

I know this is done when:

  • there is a Jinja template (for at least 1 type of README)
  • template ingests a centralized YAML file that contains "custom" values
  • template is rendered into README.md with a single command

Epic link (recommended)

No response

ford-at-aws avatar Aug 27 '22 10:08 ford-at-aws

Looks like a Retro task to me

beqqrry-aws avatar Aug 30 '22 18:08 beqqrry-aws

@ford-at-aws to do PoC

brmur avatar Sep 08 '22 17:09 brmur

https://gist.github.com/ford-at-aws/39ff3fe9929152cb7614b6df1729dbb1

ford-at-aws avatar Sep 28 '22 17:09 ford-at-aws