Skip to content

.gitignore uses bad practice #1189

@waypar

Description

@waypar

Describe the bug

I used this repo as an example and I got caught out by copying the .gitignores from here which includes cdk.context.json.
This isn't best practice according to https://docs.aws.amazon.com/cdk/v2/guide/context.html#context-construct

I saw in #689 that you don't want to remove this, fair enough, but I think it would be a good idea to add a note about it.

Expected Behavior

AWS provided sample code doesn't provide examples of bad practice.

Current Behavior

cdk.context.json is ignored without any context.

Reproduction Steps

NA

Possible Solution

See attached PR

Additional Information/Context

No response

CDK CLI Version

Framework Version

No response

Node.js Version

OS

All

Language

Typescript

Language Version

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugThis issue is a bug.needs-triageThis issue or PR still needs to be triaged.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions