Skip to content

Show sensitivity of the output value in rendered result #207

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 26, 2020

Conversation

khos2ow
Copy link
Member

@khos2ow khos2ow commented Feb 24, 2020

Prerequisites

Put an x into the box(es) that apply:

  • This pull request fixes a bug.
  • This pull request adds a feature.
  • This pull request enhances existing functionality.
  • This pull request introduces breaking change.

For more information, see the Contributing Guide.

Description

Following up #191 which adds the support for rendering output values extracted from terraform output --json command, this PR enhances it to show sensitivity of those outputs as well. e.g.

{
  ...
  "outputs": [
    {
      "name": "output-1",
      "description": "It's output number one.",
      "value": 1,
      "sensitive": false
    },
    {
      "name": "output-0.12",
      "description": "terraform 0.12 only",
      "value": "<sensitive>",
      "sensitive": true
    }
  ],
  ..
}

Note that the schema of json and yaml renderer is not changed when --output-values is not set. In other words properties value and sensitive are only available when --output-values is explicitly passed.

Issues Resolved

List any existing issues this pull request resolves.

Checklist

Put an x into all boxes that apply:

Tests

  • I have added tests to cover my changes.
  • All tests pass when I run make test.

Documentation

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Code Style

  • My code follows the code style of this project.

@khos2ow
Copy link
Member Author

khos2ow commented Feb 24, 2020

@gshel what do you think of this since you've done most of the implementation in the first place?

@khos2ow khos2ow merged commit 4ff4582 into terraform-docs:master Feb 26, 2020
@khos2ow khos2ow deleted the sensitive-values branch February 26, 2020 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant