Skip to content

Deprecate multiple flags in favor of new ones #265

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
May 20, 2020

Conversation

khos2ow
Copy link
Member

@khos2ow khos2ow commented May 20, 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 flags have been deprecated and will be removed in the following releases:

  • Flag --no-color has been deprecated, use --color=false instead
  • Flag --no-escape has been deprecated, use --escape=false instead
  • Flag --no-header has been deprecated, use --hide header instead
  • Flag --no-inputs has been deprecated, use --hide inputs instead
  • Flag --no-outputs has been deprecated, use --hide outputs instead
  • Flag --no-providers has been deprecated, use --hide providers instead
  • Flag --no-requirements has been deprecated, use --hide requirements instead
  • Flag --no-required has been deprecated, use --required=false instead
  • Flag --no-sensitive has been deprecated, use --sensitive=false instead
  • Flag --no-sort has been deprecated, use --sort=false instead

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.

@codecov-commenter
Copy link

Codecov Report

Merging #265 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #265   +/-   ##
=======================================
  Coverage   81.68%   81.68%           
=======================================
  Files          34       34           
  Lines        1796     1796           
=======================================
  Hits         1467     1467           
  Misses        274      274           
  Partials       55       55           

@khos2ow khos2ow force-pushed the deprecate-flags branch from e15cb49 to 36f4803 Compare May 20, 2020 15:30
BREAKING CHANGE: - Following flags have been deprecated and will be
removed in the following releases:

  - Flag `--no-color` has been deprecated, use `--color=false` instead

  - Flag `--no-escape` has been deprecated, use `--escape=false` instead

  - Flag `--no-header` has been deprecated, use `--hide header` instead

  - Flag `--no-inputs` has been deprecated, use `--hide inputs` instead

  - Flag `--no-outputs` has been deprecated, use `--hide outputs` instead

  - Flag `--no-providers` has been deprecated, use `--hide providers` instead

  - Flag `--no-requirements` has been deprecated, use `--hide requirements` instead

  - Flag `--no-required` has been deprecated, use `--required=false` instead

  - Flag `--no-sensitive` has been deprecated, use `--sensitive=false` instead

  - Flag `--no-sort` has been deprecated, use `--sort=false` instead
@khos2ow khos2ow force-pushed the deprecate-flags branch from 36f4803 to e80688a Compare May 20, 2020 15:42
@khos2ow khos2ow merged commit 23c50e0 into terraform-docs:master May 20, 2020
@khos2ow khos2ow deleted the deprecate-flags branch May 20, 2020 15:49
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.

2 participants