diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 49ed944..25bbffb 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,7 +8,7 @@ assignees: '' - + **Describe the bug** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index db5377b..e127df2 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,7 +8,7 @@ assignees: '' - + **Is your feature request related to a problem? Please describe.** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d345dd6..53ec3f7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,11 +7,11 @@ Put an `x` into the box(es) that apply: - [ ] This pull request enhances existing functionality. - [ ] This pull request introduces breaking change. -For more information, see the [Contributing Guide](https://github.com/segmentio/terraform-docs/tree/master/CONTRIBUTING.md). +For more information, see the [Contributing Guide](https://github.com/terraform-docs/terraform-docs/tree/master/CONTRIBUTING.md). ### Description -Describe what this pull request achieves. Ensure you have read the [Contributing Guidelines](https://github.com/segmentio/terraform-docs/tree/master/CONTRIBUTING.md) document before submitting. +Describe what this pull request achieves. Ensure you have read the [Contributing Guidelines](https://github.com/terraform-docs/terraform-docs/tree/master/CONTRIBUTING.md) document before submitting. ### Issues Resolved @@ -21,7 +21,7 @@ List any existing issues this pull request resolves. Put an `x` into all boxes that apply: -- [ ] I have read the [Contributing Guidelines](https://github.com/segmentio/terraform-docs/tree/master/CONTRIBUTING.md). +- [ ] I have read the [Contributing Guidelines](https://github.com/terraform-docs/terraform-docs/tree/master/CONTRIBUTING.md). #### Tests diff --git a/.github/workflows/validate.yaml b/.github/workflows/validate.yaml index 1827c06..a86c20f 100644 --- a/.github/workflows/validate.yaml +++ b/.github/workflows/validate.yaml @@ -95,13 +95,4 @@ jobs: uses: codecov/codecov-action@v1 if: always() with: - # Currently we're not able to build Codecov report for - # PRs originates from the fork. There's an issue to track - # this and it seems it should get resolved shortly, until - # then we hope for responsiblity in humanity and use plain - # text of the token, until further to get rotated. - # - # https://github.com/codecov/codecov-action/issues/29 - # token: ${{ secrets.CODECOV_TOKEN }} - token: 7e230f41-8fa3-4d91-8ce8-3d77b7b3f1c3 file: ./coverage.out diff --git a/CHANGELOG.md b/CHANGELOG.md index 1b09acc..23bcb11 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,15 +4,15 @@ ## [Unreleased] ### Code Refactoring -- Deprecate multiple flags in favor of new ones ([#265](https://github.com/segmentio/terraform-docs/issues/265)) -- Remove deprecated flags ([#229](https://github.com/segmentio/terraform-docs/issues/229)) -- Add factory function to return format types ([#243](https://github.com/segmentio/terraform-docs/issues/243)) -- Reorganize markdown format tests ([#244](https://github.com/segmentio/terraform-docs/issues/244)) +- Deprecate multiple flags in favor of new ones ([#265](https://github.com/terraform-docs/terraform-docs/issues/265)) +- Remove deprecated flags ([#229](https://github.com/terraform-docs/terraform-docs/issues/229)) +- Add factory function to return format types ([#243](https://github.com/terraform-docs/terraform-docs/issues/243)) +- Reorganize markdown format tests ([#244](https://github.com/terraform-docs/terraform-docs/issues/244)) ### Features -- Add support for TOML renderer ([#197](https://github.com/segmentio/terraform-docs/issues/197)) -- Add new flag to sort inputs by type ([#246](https://github.com/segmentio/terraform-docs/issues/246)) -- Add support for AsciiDoc renderer ([#241](https://github.com/segmentio/terraform-docs/issues/241)) +- Add support for TOML renderer ([#197](https://github.com/terraform-docs/terraform-docs/issues/197)) +- Add new flag to sort inputs by type ([#246](https://github.com/terraform-docs/terraform-docs/issues/246)) +- Add support for AsciiDoc renderer ([#241](https://github.com/terraform-docs/terraform-docs/issues/241)) ### BREAKING CHANGE @@ -48,96 +48,96 @@ and now are removed. ## [v0.9.1] - 2020-04-02 ### Bug Fixes -- Don't crash when reading header if 'main.tf' not found ([#235](https://github.com/segmentio/terraform-docs/issues/235)) -- Make sure requirements section is sorted ([#233](https://github.com/segmentio/terraform-docs/issues/233)) +- Don't crash when reading header if 'main.tf' not found ([#235](https://github.com/terraform-docs/terraform-docs/issues/235)) +- Make sure requirements section is sorted ([#233](https://github.com/terraform-docs/terraform-docs/issues/233)) ## [v0.9.0] - 2020-03-31 ### Bug Fixes -- Mark variables not required if default set to null ([#221](https://github.com/segmentio/terraform-docs/issues/221)) -- --no-header should not attempt reading main.tf file ([#224](https://github.com/segmentio/terraform-docs/issues/224)) -- Fix type conversion for numbers ([#204](https://github.com/segmentio/terraform-docs/issues/204)) +- Mark variables not required if default set to null ([#221](https://github.com/terraform-docs/terraform-docs/issues/221)) +- --no-header should not attempt reading main.tf file ([#224](https://github.com/terraform-docs/terraform-docs/issues/224)) +- Fix type conversion for numbers ([#204](https://github.com/terraform-docs/terraform-docs/issues/204)) ### Code Refactoring -- Add Default value types for better marshalling ([#196](https://github.com/segmentio/terraform-docs/issues/196)) -- Introduce Format interface and expose to public pkg ([#195](https://github.com/segmentio/terraform-docs/issues/195)) -- Add tfconf.Options to load Module with ([#193](https://github.com/segmentio/terraform-docs/issues/193)) +- Add Default value types for better marshalling ([#196](https://github.com/terraform-docs/terraform-docs/issues/196)) +- Introduce Format interface and expose to public pkg ([#195](https://github.com/terraform-docs/terraform-docs/issues/195)) +- Add tfconf.Options to load Module with ([#193](https://github.com/terraform-docs/terraform-docs/issues/193)) ### Documentation -- Enhance automatic document generation ([#227](https://github.com/segmentio/terraform-docs/issues/227)) -- Add installation guide for Windows users ([#218](https://github.com/segmentio/terraform-docs/issues/218)) -- Put reference to usage, cli, etc. in user guide ([#216](https://github.com/segmentio/terraform-docs/issues/216)) -- Example git hook to keep module docs up to date ([#214](https://github.com/segmentio/terraform-docs/issues/214)) -- Auto generate formats document from examples ([#192](https://github.com/segmentio/terraform-docs/issues/192)) +- Enhance automatic document generation ([#227](https://github.com/terraform-docs/terraform-docs/issues/227)) +- Add installation guide for Windows users ([#218](https://github.com/terraform-docs/terraform-docs/issues/218)) +- Put reference to usage, cli, etc. in user guide ([#216](https://github.com/terraform-docs/terraform-docs/issues/216)) +- Example git hook to keep module docs up to date ([#214](https://github.com/terraform-docs/terraform-docs/issues/214)) +- Auto generate formats document from examples ([#192](https://github.com/terraform-docs/terraform-docs/issues/192)) ### Enhancements -- Add extensive tests coverage for all the packages ([#208](https://github.com/segmentio/terraform-docs/issues/208)) +- Add extensive tests coverage for all the packages ([#208](https://github.com/terraform-docs/terraform-docs/issues/208)) ### Features -- Add support for tfvars hcl and json commands ([#226](https://github.com/segmentio/terraform-docs/issues/226)) -- Allow hiding the "Sensitive" column in markdown ([#223](https://github.com/segmentio/terraform-docs/issues/223)) -- Add section for module requirements ([#222](https://github.com/segmentio/terraform-docs/issues/222)) -- Add support for fetching the module header from any file ([#217](https://github.com/segmentio/terraform-docs/issues/217)) -- Add support for XML renderer ([#198](https://github.com/segmentio/terraform-docs/issues/198)) -- Show sensitivity of the output value in rendered result ([#207](https://github.com/segmentio/terraform-docs/issues/207)) -- Extract and render output values from Terraform ([#191](https://github.com/segmentio/terraform-docs/issues/191)) -- Render formatted results with go templates ([#177](https://github.com/segmentio/terraform-docs/issues/177)) -- Add support for YAML renderer ([#189](https://github.com/segmentio/terraform-docs/issues/189)) +- Add support for tfvars hcl and json commands ([#226](https://github.com/terraform-docs/terraform-docs/issues/226)) +- Allow hiding the "Sensitive" column in markdown ([#223](https://github.com/terraform-docs/terraform-docs/issues/223)) +- Add section for module requirements ([#222](https://github.com/terraform-docs/terraform-docs/issues/222)) +- Add support for fetching the module header from any file ([#217](https://github.com/terraform-docs/terraform-docs/issues/217)) +- Add support for XML renderer ([#198](https://github.com/terraform-docs/terraform-docs/issues/198)) +- Show sensitivity of the output value in rendered result ([#207](https://github.com/terraform-docs/terraform-docs/issues/207)) +- Extract and render output values from Terraform ([#191](https://github.com/terraform-docs/terraform-docs/issues/191)) +- Render formatted results with go templates ([#177](https://github.com/terraform-docs/terraform-docs/issues/177)) +- Add support for YAML renderer ([#189](https://github.com/terraform-docs/terraform-docs/issues/189)) ## [v0.8.2] - 2020-02-03 ### Bug Fixes -- Do not escape markdown table inside module header ([#186](https://github.com/segmentio/terraform-docs/issues/186)) -- Add double space only at the end of paragraph lines ([#185](https://github.com/segmentio/terraform-docs/issues/185)) -- Preserve asterisk list in header and fix escaping ([#179](https://github.com/segmentio/terraform-docs/issues/179)) -- Add newline between code block and trailing lines ([#184](https://github.com/segmentio/terraform-docs/issues/184)) +- Do not escape markdown table inside module header ([#186](https://github.com/terraform-docs/terraform-docs/issues/186)) +- Add double space only at the end of paragraph lines ([#185](https://github.com/terraform-docs/terraform-docs/issues/185)) +- Preserve asterisk list in header and fix escaping ([#179](https://github.com/terraform-docs/terraform-docs/issues/179)) +- Add newline between code block and trailing lines ([#184](https://github.com/terraform-docs/terraform-docs/issues/184)) ## [v0.8.1] - 2020-01-21 ### Bug Fixes -- Show native map and list as default value in JSON ([#174](https://github.com/segmentio/terraform-docs/issues/174)) +- Show native map and list as default value in JSON ([#174](https://github.com/terraform-docs/terraform-docs/issues/174)) ## [v0.8.0] - 2020-01-17 ### Bug Fixes -- Do not escape any characters of a URL ([#170](https://github.com/segmentio/terraform-docs/issues/170)) -- Add double space at the end of multi-lines paragraph ([#169](https://github.com/segmentio/terraform-docs/issues/169)) -- Show empty JSON properties, as 'null' for all types ([#166](https://github.com/segmentio/terraform-docs/issues/166)) -- Show all JSON properties, empty or null ([#160](https://github.com/segmentio/terraform-docs/issues/160)) -- Do not escape strings inside code blocks ([#155](https://github.com/segmentio/terraform-docs/issues/155)) -- Read leading module header from main.tf ([#154](https://github.com/segmentio/terraform-docs/issues/154)) -- Read leading comment lines if description is not provided ([#151](https://github.com/segmentio/terraform-docs/issues/151)) -- Reimplement '--no-sort' to be compatible with Terraform 0.12 configuration ([#141](https://github.com/segmentio/terraform-docs/issues/141)) +- Do not escape any characters of a URL ([#170](https://github.com/terraform-docs/terraform-docs/issues/170)) +- Add double space at the end of multi-lines paragraph ([#169](https://github.com/terraform-docs/terraform-docs/issues/169)) +- Show empty JSON properties, as 'null' for all types ([#166](https://github.com/terraform-docs/terraform-docs/issues/166)) +- Show all JSON properties, empty or null ([#160](https://github.com/terraform-docs/terraform-docs/issues/160)) +- Do not escape strings inside code blocks ([#155](https://github.com/terraform-docs/terraform-docs/issues/155)) +- Read leading module header from main.tf ([#154](https://github.com/terraform-docs/terraform-docs/issues/154)) +- Read leading comment lines if description is not provided ([#151](https://github.com/terraform-docs/terraform-docs/issues/151)) +- Reimplement '--no-sort' to be compatible with Terraform 0.12 configuration ([#141](https://github.com/terraform-docs/terraform-docs/issues/141)) ### Code Refactoring -- Move doc.Doc to tfconf.Module ([#136](https://github.com/segmentio/terraform-docs/issues/136)) +- Move doc.Doc to tfconf.Module ([#136](https://github.com/terraform-docs/terraform-docs/issues/136)) ### Documentation -- Initial commit of usage documentation ([#162](https://github.com/segmentio/terraform-docs/issues/162)) -- Deprecate accepting files as commands param ([#163](https://github.com/segmentio/terraform-docs/issues/163)) +- Initial commit of usage documentation ([#162](https://github.com/terraform-docs/terraform-docs/issues/162)) +- Deprecate accepting files as commands param ([#163](https://github.com/terraform-docs/terraform-docs/issues/163)) - Update Module internal documentaion ### Enhancements -- Rename flag to '--sort-by-required' ([#150](https://github.com/segmentio/terraform-docs/issues/150)) -- Mark '--with-aggregate-type-defaults' as deprecated ([#148](https://github.com/segmentio/terraform-docs/issues/148)) -- Bump homebrew formula version on release ([#135](https://github.com/segmentio/terraform-docs/issues/135)) -- Enable new go linters and fix the existing issues ([#132](https://github.com/segmentio/terraform-docs/issues/132)) +- Rename flag to '--sort-by-required' ([#150](https://github.com/terraform-docs/terraform-docs/issues/150)) +- Mark '--with-aggregate-type-defaults' as deprecated ([#148](https://github.com/terraform-docs/terraform-docs/issues/148)) +- Bump homebrew formula version on release ([#135](https://github.com/terraform-docs/terraform-docs/issues/135)) +- Enable new go linters and fix the existing issues ([#132](https://github.com/terraform-docs/terraform-docs/issues/132)) ### Features -- Add '--no-escape' flag to 'json' command ([#147](https://github.com/segmentio/terraform-docs/issues/147)) -- Add flags to not show different sections ([#144](https://github.com/segmentio/terraform-docs/issues/144)) -- Add '--no-color' flag to 'pretty' command ([#143](https://github.com/segmentio/terraform-docs/issues/143)) -- Show 'providers' information ([#140](https://github.com/segmentio/terraform-docs/issues/140)) -- Bump golang to latest v1.13 ([#133](https://github.com/segmentio/terraform-docs/issues/133)) -- Support Terraform 0.12.x configuration ([#113](https://github.com/segmentio/terraform-docs/issues/113)) +- Add '--no-escape' flag to 'json' command ([#147](https://github.com/terraform-docs/terraform-docs/issues/147)) +- Add flags to not show different sections ([#144](https://github.com/terraform-docs/terraform-docs/issues/144)) +- Add '--no-color' flag to 'pretty' command ([#143](https://github.com/terraform-docs/terraform-docs/issues/143)) +- Show 'providers' information ([#140](https://github.com/terraform-docs/terraform-docs/issues/140)) +- Bump golang to latest v1.13 ([#133](https://github.com/terraform-docs/terraform-docs/issues/133)) +- Support Terraform 0.12.x configuration ([#113](https://github.com/terraform-docs/terraform-docs/issues/113)) ### BREAKING CHANGE @@ -172,30 +172,30 @@ the second release from now. - Update Changelog - Release version v0.7.0 -- Use Github Actions instead of Circle CI ([#124](https://github.com/segmentio/terraform-docs/issues/124)) +- Use Github Actions instead of Circle CI ([#124](https://github.com/terraform-docs/terraform-docs/issues/124)) - Enhance release scripts - Generate release note based on the current tag changelog - Update Installation and Code Completion in README -- Code blocks support for all formats. Single line break support ([#123](https://github.com/segmentio/terraform-docs/issues/123)) +- Code blocks support for all formats. Single line break support ([#123](https://github.com/terraform-docs/terraform-docs/issues/123)) - Update Changelog -- target deps was missing (required by all) ([#126](https://github.com/segmentio/terraform-docs/issues/126)) -- Enhance Makefile and add editorconfig ([#115](https://github.com/segmentio/terraform-docs/issues/115)) -- Add support for controlling the indentation of Markdown headers ([#120](https://github.com/segmentio/terraform-docs/issues/120)) -- Refactor Settings for better performance ([#119](https://github.com/segmentio/terraform-docs/issues/119)) -- Add --no-escape flag for Markdown printer ([#117](https://github.com/segmentio/terraform-docs/issues/117)) +- target deps was missing (required by all) ([#126](https://github.com/terraform-docs/terraform-docs/issues/126)) +- Enhance Makefile and add editorconfig ([#115](https://github.com/terraform-docs/terraform-docs/issues/115)) +- Add support for controlling the indentation of Markdown headers ([#120](https://github.com/terraform-docs/terraform-docs/issues/120)) +- Refactor Settings for better performance ([#119](https://github.com/terraform-docs/terraform-docs/issues/119)) +- Add --no-escape flag for Markdown printer ([#117](https://github.com/terraform-docs/terraform-docs/issues/117)) - Update Changelog. -- Use Cobra CLI instead of docopt ([#116](https://github.com/segmentio/terraform-docs/issues/116)) +- Use Cobra CLI instead of docopt ([#116](https://github.com/terraform-docs/terraform-docs/issues/116)) - Update Changelog. -- Escape pipe character when generating Markdown ([#114](https://github.com/segmentio/terraform-docs/issues/114)) +- Escape pipe character when generating Markdown ([#114](https://github.com/terraform-docs/terraform-docs/issues/114)) - Add appropriate Changelog header. - Complete development requirements documentation. - Configure git-chglog to not show git merge commit messages. -- Add Changelog generation via git-chglog. ([#104](https://github.com/segmentio/terraform-docs/issues/104)) +- Add Changelog generation via git-chglog. ([#104](https://github.com/terraform-docs/terraform-docs/issues/104)) - Remove occurrence of gometalinter from CircleCI config. -- Replace dep with Go Modules ([#100](https://github.com/segmentio/terraform-docs/issues/100)) -- Replace gometalinter with golangci-lint. ([#103](https://github.com/segmentio/terraform-docs/issues/103)) -- Add 'enhancement' section to pull request template ([#101](https://github.com/segmentio/terraform-docs/issues/101)) -- Fix typo in options documentation ([#98](https://github.com/segmentio/terraform-docs/issues/98)) +- Replace dep with Go Modules ([#100](https://github.com/terraform-docs/terraform-docs/issues/100)) +- Replace gometalinter with golangci-lint. ([#103](https://github.com/terraform-docs/terraform-docs/issues/103)) +- Add 'enhancement' section to pull request template ([#101](https://github.com/terraform-docs/terraform-docs/issues/101)) +- Fix typo in options documentation ([#98](https://github.com/terraform-docs/terraform-docs/issues/98)) - Bump Homebrew formula to 0.6.0. @@ -203,17 +203,17 @@ the second release from now. ## [v0.6.0] - 2018-12-13 - Bump version to 0.6.0. -- Unify default values of inputs ([#97](https://github.com/segmentio/terraform-docs/issues/97)) -- Unify description text of inputs and outputs ([#96](https://github.com/segmentio/terraform-docs/issues/96)) +- Unify default values of inputs ([#97](https://github.com/terraform-docs/terraform-docs/issues/97)) +- Unify description text of inputs and outputs ([#96](https://github.com/terraform-docs/terraform-docs/issues/96)) - Capitalize headings in documentation. -- Fix Markdown lint errors and enhancement in README ([#94](https://github.com/segmentio/terraform-docs/issues/94)) +- Fix Markdown lint errors and enhancement in README ([#94](https://github.com/terraform-docs/terraform-docs/issues/94)) - Update project documentation. - Move Terraform test configuration to folder 'examples'. - Capitalize the word 'markdown' in documentation. - Purge History.md file. -- Add support for rendering Markdown documents ([#81](https://github.com/segmentio/terraform-docs/issues/81)) -- Migrate from github.com/tj/docopt to github.com/docopt/docopt-go ([#91](https://github.com/segmentio/terraform-docs/issues/91)) -- Fix authors target in Makefile to get 'Author''s email not 'Committer' ([#90](https://github.com/segmentio/terraform-docs/issues/90)) +- Add support for rendering Markdown documents ([#81](https://github.com/terraform-docs/terraform-docs/issues/81)) +- Migrate from github.com/tj/docopt to github.com/docopt/docopt-go ([#91](https://github.com/terraform-docs/terraform-docs/issues/91)) +- Fix authors target in Makefile to get 'Author''s email not 'Committer' ([#90](https://github.com/terraform-docs/terraform-docs/issues/90)) - Add requirement to discuss suitability of a new feature in an issue before submitting a pull request. @@ -221,33 +221,33 @@ the second release from now. ## [v0.5.0] - 2018-10-24 - Bump version to 0.5.0. -- Add support to print Markdown files with underscored variable names escaped ([#48](https://github.com/segmentio/terraform-docs/issues/48)) ([#63](https://github.com/segmentio/terraform-docs/issues/63)) +- Add support to print Markdown files with underscored variable names escaped ([#48](https://github.com/terraform-docs/terraform-docs/issues/48)) ([#63](https://github.com/terraform-docs/terraform-docs/issues/63)) - Add CircleCI badge. -- Fix homebrew formula. ([#75](https://github.com/segmentio/terraform-docs/issues/75)) -- Add sort by "required" and then name ([#43](https://github.com/segmentio/terraform-docs/issues/43)) -- Add Homebrew formula. ([#68](https://github.com/segmentio/terraform-docs/issues/68)) +- Fix homebrew formula. ([#75](https://github.com/terraform-docs/terraform-docs/issues/75)) +- Add sort by "required" and then name ([#43](https://github.com/terraform-docs/terraform-docs/issues/43)) +- Add Homebrew formula. ([#68](https://github.com/terraform-docs/terraform-docs/issues/68)) ## [v0.4.5] - 2018-10-07 - Bump version to 0.4.5. -- Allow unquoted item names. Fixes [#64](https://github.com/segmentio/terraform-docs/issues/64) ([#70](https://github.com/segmentio/terraform-docs/issues/70)) -- Change build dir structure ([#74](https://github.com/segmentio/terraform-docs/issues/74)) -- Update makefile to fix Windows build filename ([#72](https://github.com/segmentio/terraform-docs/issues/72)) -- Remove extra newlines between comments and inputs/outputs to fix MarkDownLint warnings ([#66](https://github.com/segmentio/terraform-docs/issues/66)) -- Fix loading of comments from main.tf on Windows ([#65](https://github.com/segmentio/terraform-docs/issues/65)) +- Allow unquoted item names. Fixes [#64](https://github.com/terraform-docs/terraform-docs/issues/64) ([#70](https://github.com/terraform-docs/terraform-docs/issues/70)) +- Change build dir structure ([#74](https://github.com/terraform-docs/terraform-docs/issues/74)) +- Update makefile to fix Windows build filename ([#72](https://github.com/terraform-docs/terraform-docs/issues/72)) +- Remove extra newlines between comments and inputs/outputs to fix MarkDownLint warnings ([#66](https://github.com/terraform-docs/terraform-docs/issues/66)) +- Fix loading of comments from main.tf on Windows ([#65](https://github.com/terraform-docs/terraform-docs/issues/65)) ## [v0.4.0] - 2018-09-23 - Bump version to 0.4.0. -- Add option --with-aggregate-type-defaults to enable printing of default values for types 'list' and 'map'. ([#53](https://github.com/segmentio/terraform-docs/issues/53)) -- Add option --no-sort to omit sorted rendering of inputs and outputs. ([#61](https://github.com/segmentio/terraform-docs/issues/61)) -- Refactor package 'doc' for better modularity. ([#60](https://github.com/segmentio/terraform-docs/issues/60)) -- Refactor package 'print' for better modularity. ([#59](https://github.com/segmentio/terraform-docs/issues/59)) -- Complete CircleCI config. Add vendor directory. ([#58](https://github.com/segmentio/terraform-docs/issues/58)) +- Add option --with-aggregate-type-defaults to enable printing of default values for types 'list' and 'map'. ([#53](https://github.com/terraform-docs/terraform-docs/issues/53)) +- Add option --no-sort to omit sorted rendering of inputs and outputs. ([#61](https://github.com/terraform-docs/terraform-docs/issues/61)) +- Refactor package 'doc' for better modularity. ([#60](https://github.com/terraform-docs/terraform-docs/issues/60)) +- Refactor package 'print' for better modularity. ([#59](https://github.com/terraform-docs/terraform-docs/issues/59)) +- Complete CircleCI config. Add vendor directory. ([#58](https://github.com/terraform-docs/terraform-docs/issues/58)) - Update AUTHORS. - Add issue and pull request templates. - Add contributing guidelines. @@ -266,10 +266,10 @@ the second release from now. - Add make target to clean the workspace. - Add dependency management using go deps. - Add Makefile header and build target. -- Add base CI config ([#56](https://github.com/segmentio/terraform-docs/issues/56)) -- Add Maintenance section to Readme ([#55](https://github.com/segmentio/terraform-docs/issues/55)) +- Add base CI config ([#56](https://github.com/terraform-docs/terraform-docs/issues/56)) +- Add Maintenance section to Readme ([#55](https://github.com/terraform-docs/terraform-docs/issues/55)) - Update Readme.md -- Merge pull request [#44](https://github.com/segmentio/terraform-docs/issues/44) from coveo/description-before-comments +- Merge pull request [#44](https://github.com/terraform-docs/terraform-docs/issues/44) from coveo/description-before-comments - If there is a description on an output, it should be considered before the preceding comment @@ -278,10 +278,10 @@ the second release from now. - Release v0.3.0 - auto version -- Merge pull request [#39](https://github.com/segmentio/terraform-docs/issues/39) from BWITS/[#38](https://github.com/segmentio/terraform-docs/issues/38) -- bugfix/[#38](https://github.com/segmentio/terraform-docs/issues/38) -- Merge pull request [#36](https://github.com/segmentio/terraform-docs/issues/36) from nwalke/fix_version_string -- closes [#35](https://github.com/segmentio/terraform-docs/issues/35) Updated version string +- Merge pull request [#39](https://github.com/terraform-docs/terraform-docs/issues/39) from BWITS/[#38](https://github.com/terraform-docs/terraform-docs/issues/38) +- bugfix/[#38](https://github.com/terraform-docs/terraform-docs/issues/38) +- Merge pull request [#36](https://github.com/terraform-docs/terraform-docs/issues/36) from nwalke/fix_version_string +- closes [#35](https://github.com/terraform-docs/terraform-docs/issues/35) Updated version string @@ -294,22 +294,22 @@ the second release from now. ## [v0.1.1] - 2017-08-15 - Release v0.1.1 -- Merge pull request [#34](https://github.com/segmentio/terraform-docs/issues/34) from COzero/master -- Merge pull request [#1](https://github.com/segmentio/terraform-docs/issues/1) from COzero/unquoted_names +- Merge pull request [#34](https://github.com/terraform-docs/terraform-docs/issues/34) from COzero/master +- Merge pull request [#1](https://github.com/terraform-docs/terraform-docs/issues/1) from COzero/unquoted_names - fixed name handling to handle unquoted hcl variable names. -- Merge pull request [#31](https://github.com/segmentio/terraform-docs/issues/31) from BWITS/typo +- Merge pull request [#31](https://github.com/terraform-docs/terraform-docs/issues/31) from BWITS/typo - fix typo -- Merge pull request [#28](https://github.com/segmentio/terraform-docs/issues/28) from s-urbaniak/no-required -- Merge pull request [#25](https://github.com/segmentio/terraform-docs/issues/25) from fatmcgav/support_output_description +- Merge pull request [#28](https://github.com/terraform-docs/terraform-docs/issues/28) from s-urbaniak/no-required +- Merge pull request [#25](https://github.com/terraform-docs/terraform-docs/issues/25) from fatmcgav/support_output_description - Prefer leading comments over description for outputs to maintain compatability. - *: add --no-required option - snakecase -> camelcase -- Merge pull request [#27](https://github.com/segmentio/terraform-docs/issues/27) from fatmcgav/support_printing_type +- Merge pull request [#27](https://github.com/terraform-docs/terraform-docs/issues/27) from fatmcgav/support_printing_type - Add support for printing the variable 'type' in Markdown. Currently only markdown supported, but trivial to add to other outputs. -- Add support for reading `description` tag from `output` resources. Fixes [#24](https://github.com/segmentio/terraform-docs/issues/24) -- Merge pull request [#23](https://github.com/segmentio/terraform-docs/issues/23) from jacobwgillespie/patch-1 +- Add support for reading `description` tag from `output` resources. Fixes [#24](https://github.com/terraform-docs/terraform-docs/issues/24) +- Merge pull request [#23](https://github.com/terraform-docs/terraform-docs/issues/23) from jacobwgillespie/patch-1 - Add note about installing with Homebrew -- Merge pull request [#22](https://github.com/segmentio/terraform-docs/issues/22) from jacobwgillespie/patch-1 +- Merge pull request [#22](https://github.com/terraform-docs/terraform-docs/issues/22) from jacobwgillespie/patch-1 - Strip # prefix from comments - add proper license @@ -318,20 +318,20 @@ the second release from now. ## [v0.1.0] - 2017-03-21 - Release v0.1.0 -- Merge pull request [#21](https://github.com/segmentio/terraform-docs/issues/21) from s-urbaniak/files +- Merge pull request [#21](https://github.com/terraform-docs/terraform-docs/issues/21) from s-urbaniak/files - add support for files -- Merge pull request [#20](https://github.com/segmentio/terraform-docs/issues/20) from nwalke/update_readme_example -- closes [#17](https://github.com/segmentio/terraform-docs/issues/17) Updated example in README -- Merge pull request [#19](https://github.com/segmentio/terraform-docs/issues/19) from nwalke/add_sorting -- Closes [#18](https://github.com/segmentio/terraform-docs/issues/18) Added a very basic sort to inputs and outputs -- Merge pull request [#16](https://github.com/segmentio/terraform-docs/issues/16) from paybyphone/master +- Merge pull request [#20](https://github.com/terraform-docs/terraform-docs/issues/20) from nwalke/update_readme_example +- closes [#17](https://github.com/terraform-docs/terraform-docs/issues/17) Updated example in README +- Merge pull request [#19](https://github.com/terraform-docs/terraform-docs/issues/19) from nwalke/add_sorting +- Closes [#18](https://github.com/terraform-docs/terraform-docs/issues/18) Added a very basic sort to inputs and outputs +- Merge pull request [#16](https://github.com/terraform-docs/terraform-docs/issues/16) from paybyphone/master - Account for single whitespace after comment character in header - print/markdown: Better markdown description normalizations - print/markdown: Added line break conversion for outputs - placeholder for list types - Allow top-level comments for variables when description missing - print/markdown: Replace table cell newlines with HTML line breaks -- Merge pull request [#13](https://github.com/segmentio/terraform-docs/issues/13) from jbussdieker/jbb-fix-heredoc-description +- Merge pull request [#13](https://github.com/terraform-docs/terraform-docs/issues/13) from jbussdieker/jbb-fix-heredoc-description - Trim whitespace on markdown description too - Fix HEREDOC descriptions @@ -340,9 +340,9 @@ the second release from now. ## [v0.0.2] - 2016-06-29 - Release v0.0.2 -- Merge pull request [#11](https://github.com/segmentio/terraform-docs/issues/11) from segmentio/fix-md +- Merge pull request [#11](https://github.com/terraform-docs/terraform-docs/issues/11) from terraform-docs/fix-md - wrap default values -- Merge pull request [#10](https://github.com/segmentio/terraform-docs/issues/10) from segmentio/fix-map-type +- Merge pull request [#10](https://github.com/terraform-docs/terraform-docs/issues/10) from terraform-docs/fix-map-type - fix map type - add more install notes - add dist @@ -351,11 +351,11 @@ the second release from now. ## v0.0.1 - 2016-06-15 -- Merge pull request [#5](https://github.com/segmentio/terraform-docs/issues/5) from segmentio/fix-comment +- Merge pull request [#5](https://github.com/terraform-docs/terraform-docs/issues/5) from terraform-docs/fix-comment - use /** comment for module commnet - actually print head comment - img -- Merge pull request [#4](https://github.com/segmentio/terraform-docs/issues/4) from segmentio/layout +- Merge pull request [#4](https://github.com/terraform-docs/terraform-docs/issues/4) from terraform-docs/layout - fix view - docs - ignore comments with /** prefix @@ -377,19 +377,19 @@ the second release from now. - Initial commit -[Unreleased]: https://github.com/segmentio/terraform-docs/compare/v0.9.1...HEAD -[v0.9.1]: https://github.com/segmentio/terraform-docs/compare/v0.9.0...v0.9.1 -[v0.9.0]: https://github.com/segmentio/terraform-docs/compare/v0.8.2...v0.9.0 -[v0.8.2]: https://github.com/segmentio/terraform-docs/compare/v0.8.1...v0.8.2 -[v0.8.1]: https://github.com/segmentio/terraform-docs/compare/v0.8.0...v0.8.1 -[v0.8.0]: https://github.com/segmentio/terraform-docs/compare/v0.7.0...v0.8.0 -[v0.7.0]: https://github.com/segmentio/terraform-docs/compare/v0.6.0...v0.7.0 -[v0.6.0]: https://github.com/segmentio/terraform-docs/compare/v0.5.0...v0.6.0 -[v0.5.0]: https://github.com/segmentio/terraform-docs/compare/v0.4.5...v0.5.0 -[v0.4.5]: https://github.com/segmentio/terraform-docs/compare/v0.4.0...v0.4.5 -[v0.4.0]: https://github.com/segmentio/terraform-docs/compare/v0.3.0...v0.4.0 -[v0.3.0]: https://github.com/segmentio/terraform-docs/compare/v0.2.0...v0.3.0 -[v0.2.0]: https://github.com/segmentio/terraform-docs/compare/v0.1.1...v0.2.0 -[v0.1.1]: https://github.com/segmentio/terraform-docs/compare/v0.1.0...v0.1.1 -[v0.1.0]: https://github.com/segmentio/terraform-docs/compare/v0.0.2...v0.1.0 -[v0.0.2]: https://github.com/segmentio/terraform-docs/compare/v0.0.1...v0.0.2 +[Unreleased]: https://github.com/terraform-docs/terraform-docs/compare/v0.9.1...HEAD +[v0.9.1]: https://github.com/terraform-docs/terraform-docs/compare/v0.9.0...v0.9.1 +[v0.9.0]: https://github.com/terraform-docs/terraform-docs/compare/v0.8.2...v0.9.0 +[v0.8.2]: https://github.com/terraform-docs/terraform-docs/compare/v0.8.1...v0.8.2 +[v0.8.1]: https://github.com/terraform-docs/terraform-docs/compare/v0.8.0...v0.8.1 +[v0.8.0]: https://github.com/terraform-docs/terraform-docs/compare/v0.7.0...v0.8.0 +[v0.7.0]: https://github.com/terraform-docs/terraform-docs/compare/v0.6.0...v0.7.0 +[v0.6.0]: https://github.com/terraform-docs/terraform-docs/compare/v0.5.0...v0.6.0 +[v0.5.0]: https://github.com/terraform-docs/terraform-docs/compare/v0.4.5...v0.5.0 +[v0.4.5]: https://github.com/terraform-docs/terraform-docs/compare/v0.4.0...v0.4.5 +[v0.4.0]: https://github.com/terraform-docs/terraform-docs/compare/v0.3.0...v0.4.0 +[v0.3.0]: https://github.com/terraform-docs/terraform-docs/compare/v0.2.0...v0.3.0 +[v0.2.0]: https://github.com/terraform-docs/terraform-docs/compare/v0.1.1...v0.2.0 +[v0.1.1]: https://github.com/terraform-docs/terraform-docs/compare/v0.1.0...v0.1.1 +[v0.1.0]: https://github.com/terraform-docs/terraform-docs/compare/v0.0.2...v0.1.0 +[v0.0.2]: https://github.com/terraform-docs/terraform-docs/compare/v0.0.1...v0.0.2 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a90f255..c292200 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,16 +4,16 @@ Thank you for your interest in this project! We use *GitHub Issues* for trackings issues and features. You can make a contribution by: -1. Reporting an issue or making a feature request [here](https://github.com/segmentio/terraform-docs/issues). +1. Reporting an issue or making a feature request [here](https://github.com/terraform-docs/terraform-docs/issues). 2. Contributing code to this project by fixing an issue or adding a new feature (see below). Before contributing a new feature, please discuss its suitability with the project maintainers in an issue first. Thanks! ## Contribution Process -1. Fork and *git clone* [terraform-docs](https://github.com/segmentio/terraform-docs). +1. Fork and *git clone* [terraform-docs](https://github.com/terraform-docs/terraform-docs). 2. Create a new *git branch* from the master branch where you develop your changes. -3. Create a [Pull Request](https://help.github.com/articles/about-pull-requests/) for your contribution by following the instructions in the pull request template [here](https://github.com/segmentio/terraform-docs/pull). +3. Create a [Pull Request](https://help.github.com/articles/about-pull-requests/) for your contribution by following the instructions in the pull request template [here](https://github.com/terraform-docs/terraform-docs/pull). 4. Perform a code review with the project maintainers on the pull request. We may suggest changes, improvements or alternatives. 5. Once approved, your code will be merged into `master` and your name will be included in `AUTHORS`. @@ -21,7 +21,7 @@ Before contributing a new feature, please discuss its suitability with the proje Pull requests have to meet the following requirements: -1. **Tests**: Code changes need to be tested with code and tests being located in the same folder (see packages [format](https://github.com/segmentio/terraform-docs/tree/master/internal/format/) for example). Make sure that your tests pass using `make test`. +1. **Tests**: Code changes need to be tested with code and tests being located in the same folder (see packages [format](https://github.com/terraform-docs/terraform-docs/tree/master/internal/format/) for example). Make sure that your tests pass using `make test`. 2. **Documentation**: Pull requests need to update the [Formats Guide](/docs/FORMATS_GUIDE.md) and if need be the main [README](README.md) together with the code change. You can generate the format guides by using `make docs`. diff --git a/Makefile b/Makefile index 885c3d8..f3baf9d 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,7 @@ # Project variables NAME := terraform-docs -VENDOR := segmentio -DESCRIPTION := Generate docs from Terraform modules -MAINTAINER := Martin Etmajer +VENDOR := terraform-docs +DESCRIPTION := generate documentation from Terraform modules in various output formats URL := https://github.com/$(VENDOR)/$(NAME) LICENSE := MIT @@ -29,7 +28,7 @@ GOLDFLAGS +=" GOBUILD ?= CGO_ENABLED=0 go build -ldflags $(GOLDFLAGS) GORUN ?= GOOS=$(GOOS) GOARCH=$(GOARCH) go run -GOIMPORTS_LOCAL_ARG := -local github.com/segmentio/terraform-docs +GOIMPORTS_LOCAL_ARG := -local github.com/terraform-docs/terraform-docs # Binary versions GITCHGLOG_VERSION := 0.9.1 @@ -44,7 +43,7 @@ all: clean verify checkfmt lint test build .PHONY: checkfmt checkfmt: ## Check formatting of all go files @ $(MAKE) --no-print-directory log-$@ - @ goimports -l $(GOIMPORTS_LOCAL_ARG) main.go cmd internal pkg && echo "OK" + @ goimports -l $(GOIMPORTS_LOCAL_ARG) main.go cmd/ internal/ pkg/ scripts/docs/ && echo "OK" .PHONY: clean clean: ## Clean workspace @@ -54,7 +53,7 @@ clean: ## Clean workspace .PHONY: fmt fmt: ## Format all go files @ $(MAKE) --no-print-directory log-$@ - goimports -w $(GOIMPORTS_LOCAL_ARG) main.go cmd internal pkg + goimports -w $(GOIMPORTS_LOCAL_ARG) main.go cmd/ internal/ pkg/ scripts/docs/ .PHONY: lint lint: ## Run linter diff --git a/README.md b/README.md index d0858df..f2e11cc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # terraform-docs -[![Build Status](https://github.com/segmentio/terraform-docs/workflows/build/badge.svg)](https://github.com/segmentio/terraform-docs/actions) [![GoDoc](https://godoc.org/github.com/segmentio/terraform-docs?status.svg)](https://godoc.org/github.com/segmentio/terraform-docs) [![Go Report Card](https://goreportcard.com/badge/github.com/segmentio/terraform-docs)](https://goreportcard.com/report/github.com/segmentio/terraform-docs) [![Codecov Report](https://codecov.io/gh/segmentio/terraform-docs/branch/master/graph/badge.svg)](https://codecov.io/gh/segmentio/terraform-docs) [![License](https://img.shields.io/github/license/segmentio/terraform-docs)](https://github.com/segmentio/terraform-docs/blob/master/LICENSE) [![Latest release](https://img.shields.io/github/v/release/segmentio/terraform-docs)](https://github.com/segmentio/terraform-docs/releases) +[![Build Status](https://github.com/terraform-docs/terraform-docs/workflows/build/badge.svg)](https://github.com/terraform-docs/terraform-docs/actions) [![GoDoc](https://godoc.org/github.com/terraform-docs/terraform-docs?status.svg)](https://godoc.org/github.com/terraform-docs/terraform-docs) [![Go Report Card](https://goreportcard.com/badge/github.com/terraform-docs/terraform-docs)](https://goreportcard.com/report/github.com/terraform-docs/terraform-docs) [![Codecov Report](https://codecov.io/gh/terraform-docs/terraform-docs/branch/master/graph/badge.svg)](https://codecov.io/gh/terraform-docs/terraform-docs) [![License](https://img.shields.io/github/license/terraform-docs/terraform-docs)](https://github.com/terraform-docs/terraform-docs/blob/master/LICENSE) [![Latest release](https://img.shields.io/github/v/release/terraform-docs/terraform-docs)](https://github.com/terraform-docs/terraform-docs/releases) ![terraform-docs-teaser](./images/terraform-docs-teaser.png) @@ -31,7 +31,7 @@ Read the [User Guide](./docs/USER_GUIDE.md) and [Formats Guide](./docs/FORMATS_G The latest version can be installed using `go get`: ``` bash -GO111MODULE="on" go get github.com/segmentio/terraform-docs@v0.9.1 +GO111MODULE="on" go get github.com/terraform-docs/terraform-docs@v0.9.1 ``` If you are a Mac OS X user, you can use [Homebrew](https://brew.sh): @@ -51,13 +51,13 @@ choco install terraform-docs This will put `terraform-docs` in `$(go env GOPATH)/bin`. If you encounter the error `terraform-docs: command not found` after installation then you may need to either add that directory to your `$PATH` as shown [here](https://golang.org/doc/code.html#GOPATH) or do a manual installation by cloning the repo and run `make build` from the repository which will put `terraform-docs` in: ```bash -$(go env GOPATH)/src/github.com/segmentio/terraform-docs/bin/$(uname | tr '[:upper:]' '[:lower:]')-amd64/terraform-docs +$(go env GOPATH)/src/github.com/terraform-docs/terraform-docs/bin/$(uname | tr '[:upper:]' '[:lower:]')-amd64/terraform-docs ``` -Stable binaries are also available on the [releases](https://github.com/segmentio/terraform-docs/releases) page. To install, download the binary for your platform from "Assets" and place this into your `$PATH`: +Stable binaries are also available on the [releases](https://github.com/terraform-docs/terraform-docs/releases) page. To install, download the binary for your platform from "Assets" and place this into your `$PATH`: ```bash -curl -Lo ./terraform-docs https://github.com/segmentio/terraform-docs/releases/download/v0.9.1/terraform-docs-v0.9.1-$(uname | tr '[:upper:]' '[:lower:]')-amd64 +curl -Lo ./terraform-docs https://github.com/terraform-docs/terraform-docs/releases/download/v0.9.1/terraform-docs-v0.9.1-$(uname | tr '[:upper:]' '[:lower:]')-amd64 chmod +x ./terraform-docs mv ./terraform-docs /some-dir-in-your-PATH/terraform-docs ``` @@ -110,7 +110,7 @@ Visit [./docs](./docs/) for all documentation. ## Maintenance -This project is no longer maintained by Segment. Instead, [Martin Etmajer](https://github.com/metmajer) from [GetCloudnative](https://github.com/getcloudnative) and [Khosrow Moossavi](https://github.com/khos2ow) from [CloudOps](https://github.com/cloudops) are maintaining the project with help from these awesome [contributors](AUTHORS). Note that maintainers are unaffiliated with Segment. +This project was origanially developed by [Segment](https://github.com/segmentio/) but now is no longer maintained by them. Instead, [Martin Etmajer](https://github.com/metmajer) from [GetCloudnative](https://github.com/getcloudnative) and [Khosrow Moossavi](https://github.com/khos2ow) from [CloudOps](https://github.com/cloudops) are maintaining the project with help from these awesome [contributors](AUTHORS). Note that maintainers are unaffiliated with Segment. ## License diff --git a/cmd/asciidoc/asciidoc.go b/cmd/asciidoc/asciidoc.go index df1b966..f90e691 100644 --- a/cmd/asciidoc/asciidoc.go +++ b/cmd/asciidoc/asciidoc.go @@ -3,9 +3,9 @@ package asciidoc import ( "github.com/spf13/cobra" - "github.com/segmentio/terraform-docs/cmd/asciidoc/document" - "github.com/segmentio/terraform-docs/cmd/asciidoc/table" - "github.com/segmentio/terraform-docs/internal/cli" + "github.com/terraform-docs/terraform-docs/cmd/asciidoc/document" + "github.com/terraform-docs/terraform-docs/cmd/asciidoc/table" + "github.com/terraform-docs/terraform-docs/internal/cli" ) // NewCommand returns a new cobra.Command for 'asciidoc' formatter diff --git a/cmd/asciidoc/document/document.go b/cmd/asciidoc/document/document.go index e372ab3..f3f7511 100644 --- a/cmd/asciidoc/document/document.go +++ b/cmd/asciidoc/document/document.go @@ -3,7 +3,7 @@ package document import ( "github.com/spf13/cobra" - "github.com/segmentio/terraform-docs/internal/cli" + "github.com/terraform-docs/terraform-docs/internal/cli" ) // NewCommand returns a new cobra.Command for 'asciidoc document' formatter diff --git a/cmd/asciidoc/table/table.go b/cmd/asciidoc/table/table.go index 71e2698..dca6465 100644 --- a/cmd/asciidoc/table/table.go +++ b/cmd/asciidoc/table/table.go @@ -3,7 +3,7 @@ package table import ( "github.com/spf13/cobra" - "github.com/segmentio/terraform-docs/internal/cli" + "github.com/terraform-docs/terraform-docs/internal/cli" ) // NewCommand returns a new cobra.Command for 'asciidoc table' formatter diff --git a/cmd/completion/completion.go b/cmd/completion/completion.go index aad7744..1dbbf07 100644 --- a/cmd/completion/completion.go +++ b/cmd/completion/completion.go @@ -3,8 +3,8 @@ package completion import ( "github.com/spf13/cobra" - "github.com/segmentio/terraform-docs/cmd/completion/bash" - "github.com/segmentio/terraform-docs/cmd/completion/zsh" + "github.com/terraform-docs/terraform-docs/cmd/completion/bash" + "github.com/terraform-docs/terraform-docs/cmd/completion/zsh" ) // NewCommand returns a new cobra.Command for 'completion' command diff --git a/cmd/json/json.go b/cmd/json/json.go index 33a7415..7ebf21d 100644 --- a/cmd/json/json.go +++ b/cmd/json/json.go @@ -3,7 +3,7 @@ package json import ( "github.com/spf13/cobra" - "github.com/segmentio/terraform-docs/internal/cli" + "github.com/terraform-docs/terraform-docs/internal/cli" ) // NewCommand returns a new cobra.Command for 'json' formatter diff --git a/cmd/markdown/document/document.go b/cmd/markdown/document/document.go index dbfc6eb..b314379 100644 --- a/cmd/markdown/document/document.go +++ b/cmd/markdown/document/document.go @@ -3,7 +3,7 @@ package document import ( "github.com/spf13/cobra" - "github.com/segmentio/terraform-docs/internal/cli" + "github.com/terraform-docs/terraform-docs/internal/cli" ) // NewCommand returns a new cobra.Command for 'markdown document' formatter diff --git a/cmd/markdown/markdown.go b/cmd/markdown/markdown.go index 4b4cec1..afc7d7f 100644 --- a/cmd/markdown/markdown.go +++ b/cmd/markdown/markdown.go @@ -3,9 +3,9 @@ package markdown import ( "github.com/spf13/cobra" - "github.com/segmentio/terraform-docs/cmd/markdown/document" - "github.com/segmentio/terraform-docs/cmd/markdown/table" - "github.com/segmentio/terraform-docs/internal/cli" + "github.com/terraform-docs/terraform-docs/cmd/markdown/document" + "github.com/terraform-docs/terraform-docs/cmd/markdown/table" + "github.com/terraform-docs/terraform-docs/internal/cli" ) // NewCommand returns a new cobra.Command for 'markdown' formatter diff --git a/cmd/markdown/table/table.go b/cmd/markdown/table/table.go index ce383a5..fd4fc4a 100644 --- a/cmd/markdown/table/table.go +++ b/cmd/markdown/table/table.go @@ -3,7 +3,7 @@ package table import ( "github.com/spf13/cobra" - "github.com/segmentio/terraform-docs/internal/cli" + "github.com/terraform-docs/terraform-docs/internal/cli" ) // NewCommand returns a new cobra.Command for 'markdown table' formatter diff --git a/cmd/pretty/pretty.go b/cmd/pretty/pretty.go index 9a3bf92..edc606c 100644 --- a/cmd/pretty/pretty.go +++ b/cmd/pretty/pretty.go @@ -3,7 +3,7 @@ package pretty import ( "github.com/spf13/cobra" - "github.com/segmentio/terraform-docs/internal/cli" + "github.com/terraform-docs/terraform-docs/internal/cli" ) // NewCommand returns a new cobra.Command for pretty formatter diff --git a/cmd/root.go b/cmd/root.go index 2b3db8c..85351e0 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -5,17 +5,17 @@ import ( "github.com/spf13/cobra" - "github.com/segmentio/terraform-docs/cmd/asciidoc" - "github.com/segmentio/terraform-docs/cmd/completion" - "github.com/segmentio/terraform-docs/cmd/json" - "github.com/segmentio/terraform-docs/cmd/markdown" - "github.com/segmentio/terraform-docs/cmd/pretty" - "github.com/segmentio/terraform-docs/cmd/tfvars" - "github.com/segmentio/terraform-docs/cmd/toml" - "github.com/segmentio/terraform-docs/cmd/version" - "github.com/segmentio/terraform-docs/cmd/xml" - "github.com/segmentio/terraform-docs/cmd/yaml" - "github.com/segmentio/terraform-docs/internal/cli" + "github.com/terraform-docs/terraform-docs/cmd/asciidoc" + "github.com/terraform-docs/terraform-docs/cmd/completion" + "github.com/terraform-docs/terraform-docs/cmd/json" + "github.com/terraform-docs/terraform-docs/cmd/markdown" + "github.com/terraform-docs/terraform-docs/cmd/pretty" + "github.com/terraform-docs/terraform-docs/cmd/tfvars" + "github.com/terraform-docs/terraform-docs/cmd/toml" + "github.com/terraform-docs/terraform-docs/cmd/version" + "github.com/terraform-docs/terraform-docs/cmd/xml" + "github.com/terraform-docs/terraform-docs/cmd/yaml" + "github.com/terraform-docs/terraform-docs/internal/cli" ) // Execute adds all child commands to the root command and sets flags appropriately. diff --git a/cmd/tfvars/hcl/hcl.go b/cmd/tfvars/hcl/hcl.go index f67c9bf..311ac9e 100644 --- a/cmd/tfvars/hcl/hcl.go +++ b/cmd/tfvars/hcl/hcl.go @@ -3,7 +3,7 @@ package hcl import ( "github.com/spf13/cobra" - "github.com/segmentio/terraform-docs/internal/cli" + "github.com/terraform-docs/terraform-docs/internal/cli" ) // NewCommand returns a new cobra.Command for 'tfvars hcl' formatter diff --git a/cmd/tfvars/json/json.go b/cmd/tfvars/json/json.go index ce0caa4..2f1adb5 100644 --- a/cmd/tfvars/json/json.go +++ b/cmd/tfvars/json/json.go @@ -3,7 +3,7 @@ package json import ( "github.com/spf13/cobra" - "github.com/segmentio/terraform-docs/internal/cli" + "github.com/terraform-docs/terraform-docs/internal/cli" ) // NewCommand returns a new cobra.Command for 'tfvars json' formatter diff --git a/cmd/tfvars/tfvars.go b/cmd/tfvars/tfvars.go index f878458..0852749 100644 --- a/cmd/tfvars/tfvars.go +++ b/cmd/tfvars/tfvars.go @@ -3,9 +3,9 @@ package tfvars import ( "github.com/spf13/cobra" - "github.com/segmentio/terraform-docs/cmd/tfvars/hcl" - "github.com/segmentio/terraform-docs/cmd/tfvars/json" - "github.com/segmentio/terraform-docs/internal/cli" + "github.com/terraform-docs/terraform-docs/cmd/tfvars/hcl" + "github.com/terraform-docs/terraform-docs/cmd/tfvars/json" + "github.com/terraform-docs/terraform-docs/internal/cli" ) // NewCommand returns a new cobra.Command for 'tfvars' formatter diff --git a/cmd/toml/toml.go b/cmd/toml/toml.go index bef6d73..c710cb2 100644 --- a/cmd/toml/toml.go +++ b/cmd/toml/toml.go @@ -3,7 +3,7 @@ package toml import ( "github.com/spf13/cobra" - "github.com/segmentio/terraform-docs/internal/cli" + "github.com/terraform-docs/terraform-docs/internal/cli" ) // NewCommand returns a new cobra.Command for 'toml' formatter diff --git a/cmd/version/version.go b/cmd/version/version.go index 806df79..6f0af88 100644 --- a/cmd/version/version.go +++ b/cmd/version/version.go @@ -5,7 +5,7 @@ import ( "github.com/spf13/cobra" - "github.com/segmentio/terraform-docs/internal/version" + "github.com/terraform-docs/terraform-docs/internal/version" ) // NewCommand returns a new cobra.Command for 'version' command diff --git a/cmd/xml/xml.go b/cmd/xml/xml.go index 58a4db1..6fe7ab3 100644 --- a/cmd/xml/xml.go +++ b/cmd/xml/xml.go @@ -3,7 +3,7 @@ package xml import ( "github.com/spf13/cobra" - "github.com/segmentio/terraform-docs/internal/cli" + "github.com/terraform-docs/terraform-docs/internal/cli" ) // NewCommand returns a new cobra.Command for 'xml' formatter diff --git a/cmd/yaml/yaml.go b/cmd/yaml/yaml.go index 5f80c27..e401b8c 100644 --- a/cmd/yaml/yaml.go +++ b/cmd/yaml/yaml.go @@ -3,7 +3,7 @@ package yaml import ( "github.com/spf13/cobra" - "github.com/segmentio/terraform-docs/internal/cli" + "github.com/terraform-docs/terraform-docs/internal/cli" ) // NewCommand returns a new cobra.Command for 'yaml' formatter diff --git a/go.mod b/go.mod index 79635c4..ece1b27 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/segmentio/terraform-docs +module github.com/terraform-docs/terraform-docs go 1.14 diff --git a/internal/cli/config.go b/internal/cli/config.go index eae0a0b..117b332 100644 --- a/internal/cli/config.go +++ b/internal/cli/config.go @@ -4,8 +4,8 @@ import ( "fmt" "strings" - "github.com/segmentio/terraform-docs/internal/module" - "github.com/segmentio/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/internal/module" + "github.com/terraform-docs/terraform-docs/pkg/print" ) // list of flagset items which explicitly changed from CLI diff --git a/internal/cli/run.go b/internal/cli/run.go index e3696b6..112050d 100644 --- a/internal/cli/run.go +++ b/internal/cli/run.go @@ -6,8 +6,8 @@ import ( "github.com/spf13/cobra" "github.com/spf13/pflag" - "github.com/segmentio/terraform-docs/internal/format" - "github.com/segmentio/terraform-docs/internal/module" + "github.com/terraform-docs/terraform-docs/internal/format" + "github.com/terraform-docs/terraform-docs/internal/module" ) // PreRunEFunc returns actual 'cobra.Command#PreRunE' function diff --git a/internal/format/asciidoc_document.go b/internal/format/asciidoc_document.go index 74aa5ad..1353d73 100644 --- a/internal/format/asciidoc_document.go +++ b/internal/format/asciidoc_document.go @@ -3,9 +3,9 @@ package format import ( "text/template" - "github.com/segmentio/terraform-docs/pkg/print" - "github.com/segmentio/terraform-docs/pkg/tfconf" - "github.com/segmentio/terraform-docs/pkg/tmpl" + "github.com/terraform-docs/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/pkg/tmpl" ) const ( diff --git a/internal/format/asciidoc_document_test.go b/internal/format/asciidoc_document_test.go index fb785bd..0927f96 100644 --- a/internal/format/asciidoc_document_test.go +++ b/internal/format/asciidoc_document_test.go @@ -5,9 +5,9 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/module" - "github.com/segmentio/terraform-docs/internal/testutil" - "github.com/segmentio/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/internal/module" + "github.com/terraform-docs/terraform-docs/internal/testutil" + "github.com/terraform-docs/terraform-docs/pkg/print" ) func TestAsciidocDocument(t *testing.T) { diff --git a/internal/format/asciidoc_table.go b/internal/format/asciidoc_table.go index 8488448..cd2fd29 100644 --- a/internal/format/asciidoc_table.go +++ b/internal/format/asciidoc_table.go @@ -3,9 +3,9 @@ package format import ( "text/template" - "github.com/segmentio/terraform-docs/pkg/print" - "github.com/segmentio/terraform-docs/pkg/tfconf" - "github.com/segmentio/terraform-docs/pkg/tmpl" + "github.com/terraform-docs/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/pkg/tmpl" ) const ( diff --git a/internal/format/asciidoc_table_test.go b/internal/format/asciidoc_table_test.go index c4b0b04..31cecbf 100644 --- a/internal/format/asciidoc_table_test.go +++ b/internal/format/asciidoc_table_test.go @@ -5,9 +5,9 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/module" - "github.com/segmentio/terraform-docs/internal/testutil" - "github.com/segmentio/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/internal/module" + "github.com/terraform-docs/terraform-docs/internal/testutil" + "github.com/terraform-docs/terraform-docs/pkg/print" ) func TestAsciidocTable(t *testing.T) { diff --git a/internal/format/factory.go b/internal/format/factory.go index b464769..6392f06 100644 --- a/internal/format/factory.go +++ b/internal/format/factory.go @@ -3,7 +3,7 @@ package format import ( "fmt" - "github.com/segmentio/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/pkg/print" ) // Factory initializes and returns the conceret implementation of diff --git a/internal/format/factory_test.go b/internal/format/factory_test.go index 7d266d9..a73ebde 100644 --- a/internal/format/factory_test.go +++ b/internal/format/factory_test.go @@ -6,7 +6,7 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/pkg/print" ) func TestFormatFactory(t *testing.T) { diff --git a/internal/format/json.go b/internal/format/json.go index 53cd68f..070c5ea 100644 --- a/internal/format/json.go +++ b/internal/format/json.go @@ -5,8 +5,8 @@ import ( "encoding/json" "strings" - "github.com/segmentio/terraform-docs/pkg/print" - "github.com/segmentio/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" ) // JSON represents JSON format. diff --git a/internal/format/json_test.go b/internal/format/json_test.go index 5b2fced..0a03a0e 100644 --- a/internal/format/json_test.go +++ b/internal/format/json_test.go @@ -5,9 +5,9 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/module" - "github.com/segmentio/terraform-docs/internal/testutil" - "github.com/segmentio/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/internal/module" + "github.com/terraform-docs/terraform-docs/internal/testutil" + "github.com/terraform-docs/terraform-docs/pkg/print" ) func TestJson(t *testing.T) { diff --git a/internal/format/markdown_document.go b/internal/format/markdown_document.go index 3b250d1..5ac3dde 100644 --- a/internal/format/markdown_document.go +++ b/internal/format/markdown_document.go @@ -3,9 +3,9 @@ package format import ( "text/template" - "github.com/segmentio/terraform-docs/pkg/print" - "github.com/segmentio/terraform-docs/pkg/tfconf" - "github.com/segmentio/terraform-docs/pkg/tmpl" + "github.com/terraform-docs/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/pkg/tmpl" ) const ( diff --git a/internal/format/markdown_document_test.go b/internal/format/markdown_document_test.go index 1d3465a..d47e5e0 100644 --- a/internal/format/markdown_document_test.go +++ b/internal/format/markdown_document_test.go @@ -5,9 +5,9 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/module" - "github.com/segmentio/terraform-docs/internal/testutil" - "github.com/segmentio/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/internal/module" + "github.com/terraform-docs/terraform-docs/internal/testutil" + "github.com/terraform-docs/terraform-docs/pkg/print" ) func TestDocument(t *testing.T) { diff --git a/internal/format/markdown_table.go b/internal/format/markdown_table.go index 33eb027..0424088 100644 --- a/internal/format/markdown_table.go +++ b/internal/format/markdown_table.go @@ -3,9 +3,9 @@ package format import ( "text/template" - "github.com/segmentio/terraform-docs/pkg/print" - "github.com/segmentio/terraform-docs/pkg/tfconf" - "github.com/segmentio/terraform-docs/pkg/tmpl" + "github.com/terraform-docs/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/pkg/tmpl" ) const ( diff --git a/internal/format/markdown_table_test.go b/internal/format/markdown_table_test.go index 6c93573..5d74828 100644 --- a/internal/format/markdown_table_test.go +++ b/internal/format/markdown_table_test.go @@ -5,9 +5,9 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/module" - "github.com/segmentio/terraform-docs/internal/testutil" - "github.com/segmentio/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/internal/module" + "github.com/terraform-docs/terraform-docs/internal/testutil" + "github.com/terraform-docs/terraform-docs/pkg/print" ) func TestTable(t *testing.T) { diff --git a/internal/format/pretty.go b/internal/format/pretty.go index 36a4b40..83eaf7c 100644 --- a/internal/format/pretty.go +++ b/internal/format/pretty.go @@ -4,9 +4,9 @@ import ( "fmt" "text/template" - "github.com/segmentio/terraform-docs/pkg/print" - "github.com/segmentio/terraform-docs/pkg/tfconf" - "github.com/segmentio/terraform-docs/pkg/tmpl" + "github.com/terraform-docs/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/pkg/tmpl" ) const ( diff --git a/internal/format/pretty_test.go b/internal/format/pretty_test.go index 0a68677..9139f15 100644 --- a/internal/format/pretty_test.go +++ b/internal/format/pretty_test.go @@ -5,9 +5,9 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/module" - "github.com/segmentio/terraform-docs/internal/testutil" - "github.com/segmentio/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/internal/module" + "github.com/terraform-docs/terraform-docs/internal/testutil" + "github.com/terraform-docs/terraform-docs/pkg/print" ) func TestPretty(t *testing.T) { diff --git a/internal/format/tfvars_hcl.go b/internal/format/tfvars_hcl.go index 078f564..c8becaf 100644 --- a/internal/format/tfvars_hcl.go +++ b/internal/format/tfvars_hcl.go @@ -6,9 +6,9 @@ import ( "strings" "text/template" - "github.com/segmentio/terraform-docs/pkg/print" - "github.com/segmentio/terraform-docs/pkg/tfconf" - "github.com/segmentio/terraform-docs/pkg/tmpl" + "github.com/terraform-docs/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/pkg/tmpl" ) const ( diff --git a/internal/format/tfvars_hcl_test.go b/internal/format/tfvars_hcl_test.go index f331ecb..1b495ce 100644 --- a/internal/format/tfvars_hcl_test.go +++ b/internal/format/tfvars_hcl_test.go @@ -5,9 +5,9 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/module" - "github.com/segmentio/terraform-docs/internal/testutil" - "github.com/segmentio/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/internal/module" + "github.com/terraform-docs/terraform-docs/internal/testutil" + "github.com/terraform-docs/terraform-docs/pkg/print" ) func TestTfvarsHcl(t *testing.T) { diff --git a/internal/format/tfvars_json.go b/internal/format/tfvars_json.go index a9313dc..ace6b38 100644 --- a/internal/format/tfvars_json.go +++ b/internal/format/tfvars_json.go @@ -7,8 +7,8 @@ import ( "github.com/iancoleman/orderedmap" - "github.com/segmentio/terraform-docs/pkg/print" - "github.com/segmentio/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" ) // TfvarsJSON represents Terraform tfvars JSON format. diff --git a/internal/format/tfvars_json_test.go b/internal/format/tfvars_json_test.go index 56941f8..d8e3535 100644 --- a/internal/format/tfvars_json_test.go +++ b/internal/format/tfvars_json_test.go @@ -5,9 +5,9 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/module" - "github.com/segmentio/terraform-docs/internal/testutil" - "github.com/segmentio/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/internal/module" + "github.com/terraform-docs/terraform-docs/internal/testutil" + "github.com/terraform-docs/terraform-docs/pkg/print" ) func TestTfvarsJson(t *testing.T) { diff --git a/internal/format/toml.go b/internal/format/toml.go index 80bd55e..a6cae03 100644 --- a/internal/format/toml.go +++ b/internal/format/toml.go @@ -5,8 +5,8 @@ import ( "github.com/BurntSushi/toml" - "github.com/segmentio/terraform-docs/pkg/print" - "github.com/segmentio/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" ) // TOML represents TOML format. diff --git a/internal/format/toml_test.go b/internal/format/toml_test.go index 82d2300..f7feeec 100644 --- a/internal/format/toml_test.go +++ b/internal/format/toml_test.go @@ -5,9 +5,9 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/module" - "github.com/segmentio/terraform-docs/internal/testutil" - "github.com/segmentio/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/internal/module" + "github.com/terraform-docs/terraform-docs/internal/testutil" + "github.com/terraform-docs/terraform-docs/pkg/print" ) func TestToml(t *testing.T) { diff --git a/internal/format/xml.go b/internal/format/xml.go index 367191a..f88f2b7 100644 --- a/internal/format/xml.go +++ b/internal/format/xml.go @@ -4,8 +4,8 @@ import ( "encoding/xml" "strings" - "github.com/segmentio/terraform-docs/pkg/print" - "github.com/segmentio/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" ) // XML represents XML format. diff --git a/internal/format/xml_test.go b/internal/format/xml_test.go index b176ed6..2af0b2b 100644 --- a/internal/format/xml_test.go +++ b/internal/format/xml_test.go @@ -5,9 +5,9 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/module" - "github.com/segmentio/terraform-docs/internal/testutil" - "github.com/segmentio/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/internal/module" + "github.com/terraform-docs/terraform-docs/internal/testutil" + "github.com/terraform-docs/terraform-docs/pkg/print" ) func TestXml(t *testing.T) { diff --git a/internal/format/yaml.go b/internal/format/yaml.go index c9868ab..6e01678 100644 --- a/internal/format/yaml.go +++ b/internal/format/yaml.go @@ -6,8 +6,8 @@ import ( "gopkg.in/yaml.v3" - "github.com/segmentio/terraform-docs/pkg/print" - "github.com/segmentio/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" ) // YAML represents YAML format. diff --git a/internal/format/yaml_test.go b/internal/format/yaml_test.go index 3e9d273..b67bc16 100644 --- a/internal/format/yaml_test.go +++ b/internal/format/yaml_test.go @@ -5,9 +5,9 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/module" - "github.com/segmentio/terraform-docs/internal/testutil" - "github.com/segmentio/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/internal/module" + "github.com/terraform-docs/terraform-docs/internal/testutil" + "github.com/terraform-docs/terraform-docs/pkg/print" ) func TestYaml(t *testing.T) { diff --git a/internal/module/input.go b/internal/module/input.go index 5804ab7..32c0a59 100644 --- a/internal/module/input.go +++ b/internal/module/input.go @@ -1,7 +1,7 @@ package module import ( - "github.com/segmentio/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" ) type inputsSortedByName []*tfconf.Input diff --git a/internal/module/input_test.go b/internal/module/input_test.go index c90e542..f843472 100644 --- a/internal/module/input_test.go +++ b/internal/module/input_test.go @@ -6,8 +6,8 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/types" - "github.com/segmentio/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/internal/types" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" ) func TestInputsSortedByName(t *testing.T) { diff --git a/internal/module/module.go b/internal/module/module.go index e5a0b5f..8b317c5 100644 --- a/internal/module/module.go +++ b/internal/module/module.go @@ -10,10 +10,10 @@ import ( "sort" "strings" - "github.com/segmentio/terraform-docs/internal/reader" - "github.com/segmentio/terraform-docs/internal/tfconfig" - "github.com/segmentio/terraform-docs/internal/types" - "github.com/segmentio/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/internal/reader" + "github.com/terraform-docs/terraform-docs/internal/tfconfig" + "github.com/terraform-docs/terraform-docs/internal/types" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" ) // LoadWithOptions returns new instance of Module with all the inputs and diff --git a/internal/module/output.go b/internal/module/output.go index 845297e..b62dee3 100644 --- a/internal/module/output.go +++ b/internal/module/output.go @@ -1,7 +1,7 @@ package module import ( - "github.com/segmentio/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" ) // TerraformOutput is used for unmarshalling `terraform outputs --json` into diff --git a/internal/module/output_test.go b/internal/module/output_test.go index 78bf1c1..f2aaa04 100644 --- a/internal/module/output_test.go +++ b/internal/module/output_test.go @@ -6,8 +6,8 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/types" - "github.com/segmentio/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/internal/types" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" ) func TestOutputsSortedByName(t *testing.T) { diff --git a/internal/module/provider.go b/internal/module/provider.go index 440806d..a23c79a 100644 --- a/internal/module/provider.go +++ b/internal/module/provider.go @@ -1,7 +1,7 @@ package module import ( - "github.com/segmentio/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" ) type providersSortedByName []*tfconf.Provider diff --git a/internal/module/provider_test.go b/internal/module/provider_test.go index 0684903..8444199 100644 --- a/internal/module/provider_test.go +++ b/internal/module/provider_test.go @@ -6,8 +6,8 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/types" - "github.com/segmentio/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/internal/types" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" ) func TestProvidersSortedByName(t *testing.T) { diff --git a/internal/testutil/settings.go b/internal/testutil/settings.go index 4e285e2..0334439 100644 --- a/internal/testutil/settings.go +++ b/internal/testutil/settings.go @@ -3,7 +3,7 @@ package testutil import ( "github.com/imdario/mergo" - "github.com/segmentio/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/pkg/print" ) // TestSettings respresents the Settings instance for tests diff --git a/internal/testutil/testing.go b/internal/testutil/testing.go index e90dc5d..e5af735 100644 --- a/internal/testutil/testing.go +++ b/internal/testutil/testing.go @@ -6,8 +6,8 @@ import ( "path/filepath" "runtime" - "github.com/segmentio/terraform-docs/internal/module" - "github.com/segmentio/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/internal/module" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" ) // GetModule returns 'example' Module diff --git a/main.go b/main.go index e212a6e..639a10c 100644 --- a/main.go +++ b/main.go @@ -3,7 +3,7 @@ package main import ( "os" - "github.com/segmentio/terraform-docs/cmd" + "github.com/terraform-docs/terraform-docs/cmd" ) func main() { diff --git a/pkg/print/print.go b/pkg/print/print.go index 2fc8c4f..a740a42 100644 --- a/pkg/print/print.go +++ b/pkg/print/print.go @@ -1,7 +1,7 @@ package print import ( - "github.com/segmentio/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" ) // Format represents a printer format (e.g. json, table, yaml, ...) diff --git a/pkg/tfconf/input.go b/pkg/tfconf/input.go index 1f66bb8..f493f7b 100644 --- a/pkg/tfconf/input.go +++ b/pkg/tfconf/input.go @@ -3,7 +3,7 @@ package tfconf import ( "encoding/json" - "github.com/segmentio/terraform-docs/internal/types" + "github.com/terraform-docs/terraform-docs/internal/types" ) // Input represents a Terraform input. diff --git a/pkg/tfconf/input_test.go b/pkg/tfconf/input_test.go index 75489aa..3858b63 100644 --- a/pkg/tfconf/input_test.go +++ b/pkg/tfconf/input_test.go @@ -5,7 +5,7 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/types" + "github.com/terraform-docs/terraform-docs/internal/types" ) func TestInputValue(t *testing.T) { diff --git a/pkg/tfconf/output.go b/pkg/tfconf/output.go index c862300..9de0210 100644 --- a/pkg/tfconf/output.go +++ b/pkg/tfconf/output.go @@ -5,7 +5,7 @@ import ( "encoding/json" "encoding/xml" - "github.com/segmentio/terraform-docs/internal/types" + "github.com/terraform-docs/terraform-docs/internal/types" ) // Output represents a Terraform output. diff --git a/pkg/tfconf/output_test.go b/pkg/tfconf/output_test.go index 188723f..74a80b4 100644 --- a/pkg/tfconf/output_test.go +++ b/pkg/tfconf/output_test.go @@ -8,7 +8,7 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/types" + "github.com/terraform-docs/terraform-docs/internal/types" ) func TestOutputValue(t *testing.T) { diff --git a/pkg/tfconf/provider.go b/pkg/tfconf/provider.go index 96755e7..9bd29a5 100644 --- a/pkg/tfconf/provider.go +++ b/pkg/tfconf/provider.go @@ -3,7 +3,7 @@ package tfconf import ( "fmt" - "github.com/segmentio/terraform-docs/internal/types" + "github.com/terraform-docs/terraform-docs/internal/types" ) // Provider represents a Terraform output. diff --git a/pkg/tfconf/provider_test.go b/pkg/tfconf/provider_test.go index 2562294..2b94109 100644 --- a/pkg/tfconf/provider_test.go +++ b/pkg/tfconf/provider_test.go @@ -5,7 +5,7 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/types" + "github.com/terraform-docs/terraform-docs/internal/types" ) func TestProviderNameWithoutAlias(t *testing.T) { diff --git a/pkg/tfconf/requirement.go b/pkg/tfconf/requirement.go index cb6f065..f66730d 100644 --- a/pkg/tfconf/requirement.go +++ b/pkg/tfconf/requirement.go @@ -1,7 +1,7 @@ package tfconf import ( - "github.com/segmentio/terraform-docs/internal/types" + "github.com/terraform-docs/terraform-docs/internal/types" ) // Requirement represents a requirement for Terraform module. diff --git a/pkg/tmpl/sanitizer.go b/pkg/tmpl/sanitizer.go index 17c55c2..54bcec9 100644 --- a/pkg/tmpl/sanitizer.go +++ b/pkg/tmpl/sanitizer.go @@ -8,7 +8,7 @@ import ( "mvdan.cc/xurls/v2" - "github.com/segmentio/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/pkg/print" ) // sanitizeName escapes underscore character which have special meaning in Markdown. diff --git a/pkg/tmpl/sanitizer_test.go b/pkg/tmpl/sanitizer_test.go index 8c24e8d..c9103ce 100644 --- a/pkg/tmpl/sanitizer_test.go +++ b/pkg/tmpl/sanitizer_test.go @@ -7,8 +7,8 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/testutil" - "github.com/segmentio/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/internal/testutil" + "github.com/terraform-docs/terraform-docs/pkg/print" ) func TestSanitizeName(t *testing.T) { diff --git a/pkg/tmpl/template.go b/pkg/tmpl/template.go index f8e3797..4f1a8f7 100644 --- a/pkg/tmpl/template.go +++ b/pkg/tmpl/template.go @@ -6,9 +6,9 @@ import ( "strings" "text/template" - "github.com/segmentio/terraform-docs/internal/types" - "github.com/segmentio/terraform-docs/pkg/print" - "github.com/segmentio/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/internal/types" + "github.com/terraform-docs/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" ) // Item represents a named templated which can reference diff --git a/pkg/tmpl/template_test.go b/pkg/tmpl/template_test.go index 6aecf40..2ee3c82 100644 --- a/pkg/tmpl/template_test.go +++ b/pkg/tmpl/template_test.go @@ -10,9 +10,9 @@ import ( "github.com/stretchr/testify/assert" - "github.com/segmentio/terraform-docs/internal/types" - "github.com/segmentio/terraform-docs/pkg/print" - "github.com/segmentio/terraform-docs/pkg/tfconf" + "github.com/terraform-docs/terraform-docs/internal/types" + "github.com/terraform-docs/terraform-docs/pkg/print" + "github.com/terraform-docs/terraform-docs/pkg/tfconf" ) func TestTemplateRender(t *testing.T) { diff --git a/scripts/chglog/config-full-history.yml b/scripts/chglog/config-full-history.yml index e119526..f42bb41 100755 --- a/scripts/chglog/config-full-history.yml +++ b/scripts/chglog/config-full-history.yml @@ -2,7 +2,7 @@ style: github template: CHANGELOG-full-history.tpl.md info: title: CHANGELOG - repository_url: https://github.com/segmentio/terraform-docs + repository_url: https://github.com/terraform-docs/terraform-docs options: commits: filters: diff --git a/scripts/chglog/config-release-note.yml b/scripts/chglog/config-release-note.yml index dbe5ad3..56eef64 100755 --- a/scripts/chglog/config-release-note.yml +++ b/scripts/chglog/config-release-note.yml @@ -2,7 +2,7 @@ style: github template: CHANGELOG-release-note.tpl.md info: title: CHANGELOG - repository_url: https://github.com/segmentio/terraform-docs + repository_url: https://github.com/terraform-docs/terraform-docs options: commits: filters: diff --git a/scripts/docs/generate.go b/scripts/docs/generate.go index 784378b..78ed7ae 100644 --- a/scripts/docs/generate.go +++ b/scripts/docs/generate.go @@ -10,11 +10,12 @@ import ( "strings" "time" - "github.com/segmentio/terraform-docs/cmd" - "github.com/segmentio/terraform-docs/internal/format" - "github.com/segmentio/terraform-docs/internal/module" - "github.com/segmentio/terraform-docs/pkg/print" "github.com/spf13/cobra" + + "github.com/terraform-docs/terraform-docs/cmd" + "github.com/terraform-docs/terraform-docs/internal/format" + "github.com/terraform-docs/terraform-docs/internal/module" + "github.com/terraform-docs/terraform-docs/pkg/print" ) // These are practiaclly a copy/paste of https://github.com/spf13/cobra/blob/master/doc/md_docs.go diff --git a/scripts/homebrew/terraform-docs.rb b/scripts/homebrew/terraform-docs.rb index 952a09e..900e917 100644 --- a/scripts/homebrew/terraform-docs.rb +++ b/scripts/homebrew/terraform-docs.rb @@ -1,7 +1,7 @@ class TerraformDocs < Formula desc "Tool to generate documentation from Terraform modules" - homepage "https://github.com/segmentio/terraform-docs" - url "https://github.com/segmentio/terraform-docs/archive/v0.8.2.tar.gz" + homepage "https://github.com/terraform-docs/terraform-docs" + url "https://github.com/terraform-docs/terraform-docs/archive/v0.8.2.tar.gz" sha256 "005957c5c5d56a27e60ca735128231f68c3f099b433a7041a0f1591bee59fbd0" bottle do