aws-cloudformation / aws-cloudformation/cloudformation-cli-go-plugin

Logging unavailable at runtime unless `logging` tag passed to compile

Open
#187 8 comments 8 reactions 1 assignee Claimed by @brianterry View on GitHub
bug Researching
Dominant language
Go
Stars
53
Forks
31
PR merge metrics
No merged PRs in 30d

Description

If you create a new project using the Go template, no logging will be received unless the project is compiled with the `logging` tag.

This can be done by changing the `makebuild` file to include the tag, or running make with the `TAGS` environment variable defined:

```
TAGS=logging make
```

How can this be made more obvious?

Suggestions:

* add a comment in the generated `makebuild` file to note the values accepted by `TAGS` and the effect
* add a comment in the generated `resource.go` describing how logging can be enabled
* add documentation on the README

I found out the way to enable logging via a hint in https://github.com/aws-cloudformation/cloudformation-cli/issues/391; this could be made more discoverable for others.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.