genreadme-from-awsyaml v0.0.5

Usage

Flags

-o Output file name; ex: README.md -t Template file to generate README.md; ex: README-template.md -a AWS Cloud Formation template file; ex: template.yml -c Resource Config file; ex: resource_config.json

genreadme-from-awsyaml -o README.md -t README-template.md -a template.yaml -c resource_config.json

Sample files:

• Template file

    AWS Resurce Created from this stack:

    <% resources.forEach((role)=>{%> 
    ### <span style='color:gray'><%=role.type%>&nbsp;&nbsp;:-&nbsp;&nbsp;<%=role.resources.length%></span>

    <% role.resources.forEach((resource)=>{%> 
    - ##### <%=resource.name%>&nbsp;&nbsp;:-&nbsp;&nbsp;<span style='color:grey;font-weight:400'><i><%=resource.description%></i></span>
    <%});%>  
    <br/>
    <%});%>

• Resource Config File

  Configure the resources and attributes to display in README

    [
        {
            "type": "AWS::IAM::Role",
            "name": "RoleName",
            "description": "Description"
        },
        {
            "type": "AWS::IAM::ManagedPolicy",
            "name": "ManagedPolicyName",
            "description": "Description"
        },
        {
            "type": "AWS::IAM::Policy",
            "name": "PolicyName",
            "description": "Description"
        },
        {
            "type": "AWS::Athena::WorkGroup",
            "name": "Name",
            "description": "Description"
        },
        {
            "type": "AWS::Glue::Database",
            "name": "DatabaseInput.Name",
            "description": "DatabaseInput.Description"
        },
        {
            "type": "AWS::Lambda::Function",
            "name": "FunctionName",
            "description": "Description"
        }
        ... more resources
    ]