Downloads:

2,431

Downloads of v 0.8.2:

333

Last Update:

04 Mar 2020

Package Maintainer(s):

Software Author(s):

  • segement

Tags:

terraform terraform-docs

Terrform-Docs

This is not the latest version of Terrform-Docs available.

0.8.2 | Updated: 04 Mar 2020

Downloads:

2,431

Downloads of v 0.8.2:

333

Software Author(s):

  • segement

Terrform-Docs 0.8.2

This is not the latest version of Terrform-Docs available.

All Checks are Passing

2 Passing Test


Validation Testing Passed


Verification Testing Passed

Details

To install Terrform-Docs, run the following command from the command line or from PowerShell:

>

To upgrade Terrform-Docs, run the following command from the command line or from PowerShell:

>

To uninstall Terrform-Docs, run the following command from the command line or from PowerShell:

>

NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://chocolatey.org/api/v2. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Enter your internal repository url

(this should look similar to https://chocolatey.org/api/v2)

4. Choose your deployment method:


choco upgrade terraform-docs -y --source="'STEP 3 URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade terraform-docs -y --source="'STEP 3 URL'"
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Ensure terraform-docs installed
  win_chocolatey:
    name: terraform-docs
    state: present
    version: 0.8.2
    source: STEP 3 URL

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.

Coming early 2020! Central Managment Reporting available now! More information...


chocolatey_package 'terraform-docs' do
  action    :install
  version  '0.8.2'
  source   'STEP 3 URL'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


Chocolatey::Ensure-Package
(
    Name: terraform-docs,
    Version: 0.8.2,
    Source: STEP 3 URL
);

Requires Otter Chocolatey Extension. See docs at https://inedo.com/den/otter/chocolatey.


cChocoPackageInstaller terraform-docs
{
   Name     = 'terraform-docs'
   Ensure   = 'Present'
   Version  = '0.8.2'
   Source   = 'STEP 3 URL'
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'terraform-docs':
  provider => 'chocolatey',
  ensure   => '0.8.2',
  source   => 'STEP 3 URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


salt '*' chocolatey.install terraform-docs version="0.8.2" source="STEP 3 URL"

See docs at https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.chocolatey.html.

5. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

Private CDN cached downloads available for licensed customers. Never experience 404 breakages again! Learn more...

This package was approved by moderator flcdrg on 08 Mar 2020.

Description

A utility to generate documentation from Terraform modules in various output formats..


tools\chocolateybeforemodify.ps1
$ErrorActionPreference = "Stop"
write-host "Attempting to stop any running terraform-docs processes, to allow upgrade"
try
{
  $running = get-process terraform-docs
}
catch
{
  write-host "No running terraform-docs processes to stop"
  $running = @()
}
  
if ($running)
{
  write-host "Stopping terraform-docs processes"
  foreach($p in $running)
  {
    stop-process $p
    write-verbose "Stopped $($p.ProcessName) $($p.Id)"
  }
}
tools\chocolateyinstall.ps1
$ErrorActionPreference = 'Stop'
 
$packageName = 'terraform-docs'
$toolsPath = Split-Path $MyInvocation.MyCommand.Definition
$checksum = 'dbba61a77e0317ec5d0977c9f10b88b272f177e8f9e29ead1232ce68a8ed4675'
$url      = 'https://github.com/segmentio/terraform-docs/releases/download/v0.8.2/terraform-docs-v0.8.2-windows-amd64.exe'
$destination = "$toolsPath\terraform-docs-v0.8.2-windows-amd64.exe"

if (Test-Path "$toolsPath\terraform-docs.exe") {
  Remove-Item "$toolsPath\terraform-docs.exe"
  Uninstall-BinFile -Name "terraform-docs" -Path "$toolsPath"
}

Get-ChocolateyWebFile -PackageName $packageName -FileFullPath $destination -Url64bit $url -Checksum64 $checksum -ChecksumType64 sha256
Rename-Item -Path "$toolsPath\terraform-docs-v0.8.2-windows-amd64.exe" -NewName "terraform-docs.exe"

Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Version Downloads Last Updated Status
terraform-docs 0.11.1 60 Thursday, February 18, 2021 Approved
terraform-docs 0.11.0 88 Wednesday, February 10, 2021 Approved
terraform-docs 0.10.1 696 Tuesday, October 13, 2020 Approved
terraform-docs 0.10.0 18 Tuesday, October 13, 2020 Approved
Terrform-Docs 0.9.1 879 Friday, April 10, 2020 Approved
Terrform-Docs 0.9.0 28 Tuesday, March 31, 2020 Approved
Terrform-Docs 0.8.2 333 Wednesday, March 4, 2020 Approved
Terrform-Docs 0.7.0 99 Sunday, December 15, 2019 Approved
Terrform-Docs 0.6.0 68 Monday, November 11, 2019 Approved

This package has no dependencies.

Discussion for the Terrform-Docs Package

Ground Rules:

  • This discussion is only about Terrform-Docs and the Terrform-Docs package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Terrform-Docs, or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus