3.md (10461B)
1 # PR #3 Bump github.com/hashicorp/terraform-plugin-docs from 0.16.0 to 0.18.0 2 3 - **Status:** open 4 - **Author:** @dependabot[bot] 5 - **Created:** 2024-01-25T02:46:37Z 6 - **Branch:** dependabot/go_modules/github.com/hashicorp/terraform-plugin-docs-0.18.0 → main 7 - **Labels:** dependencies 8 - **Diff:** [3.diff](./3.diff) 9 10 --- 11 12 Bumps [github.com/hashicorp/terraform-plugin-docs](https://github.com/hashicorp/terraform-plugin-docs) from 0.16.0 to 0.18.0. 13 <details> 14 <summary>Release notes</summary> 15 <p><em>Sourced from <a href="https://github.com/hashicorp/terraform-plugin-docs/releases">github.com/hashicorp/terraform-plugin-docs's releases</a>.</em></p> 16 <blockquote> 17 <h2>v0.18.0</h2> 18 <p>FEATURES:</p> 19 <ul> 20 <li>generate: Add support for Provider-defined Function documentation (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/328">#328</a>)</li> 21 <li>migrate: Add support for Provider-defined Function documentation (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/328">#328</a>)</li> 22 </ul> 23 <p>ENHANCEMENTS:</p> 24 <ul> 25 <li>validate: Add <code>functions</code> to list of allowed template and rendered website subdirectories (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/328">#328</a>)</li> 26 </ul> 27 <h2>v0.17.0</h2> 28 <p>BREAKING CHANGES:</p> 29 <ul> 30 <li>generate: templates using <code>printf</code> with either <code>codefile</code> or <code>tffile</code> to render code examples in markdown will need to switch to using those functions directly. 31 For example, switch the following template code: 32 <code>{{printf "{{codefile \"shell\" %q}}" .ImportFile}}</code> 33 to 34 <code>{{codefile "shell" .ImportFile}}</code> (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/300">#300</a>)</li> 35 </ul> 36 <p>FEATURES:</p> 37 <ul> 38 <li>migrate: Added new <code>migrate</code> subcommand that migrates existing provider docs using the rendered website source directories (<code>website/docs/</code> or <code>/docs/</code>) to a <code>terraform-plugin-docs</code>-supported templates directory. (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/314">#314</a>)</li> 39 </ul> 40 <p>ENHANCEMENTS:</p> 41 <ul> 42 <li>generate: Add <code>provider-schema</code> flag to pass in a file path to a provider schema JSON file, allowing the command to skip building the provider and calling Terraform CLI (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/299">#299</a>)</li> 43 </ul> 44 <p>BUG FIXES:</p> 45 <ul> 46 <li>generate: fix <code>no such file or directory</code> error when running <code>generate</code> with no existing rendered website directory. (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/296">#296</a>)</li> 47 <li>generate: fix incorrect rendering of example and import files for providers with no docs templates or with generic fallback templates. (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/300">#300</a>)</li> 48 </ul> 49 </blockquote> 50 </details> 51 <details> 52 <summary>Changelog</summary> 53 <p><em>Sourced from <a href="https://github.com/hashicorp/terraform-plugin-docs/blob/main/CHANGELOG.md">github.com/hashicorp/terraform-plugin-docs's changelog</a>.</em></p> 54 <blockquote> 55 <h2>0.18.0 (January 24, 2024)</h2> 56 <p>FEATURES:</p> 57 <ul> 58 <li>generate: Add support for Provider-defined Function documentation (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/328">#328</a>)</li> 59 <li>migrate: Add support for Provider-defined Function documentation (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/328">#328</a>)</li> 60 </ul> 61 <p>ENHANCEMENTS:</p> 62 <ul> 63 <li>validate: Add <code>functions</code> to list of allowed template and rendered website subdirectories (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/328">#328</a>)</li> 64 </ul> 65 <h2>0.17.0 (January 17, 2024)</h2> 66 <p>BREAKING CHANGES:</p> 67 <ul> 68 <li>generate: templates using <code>printf</code> with either <code>codefile</code> or <code>tffile</code> to render code examples in markdown will need to switch to using those functions directly. 69 For example, switch the following template code: 70 <code>{{printf "{{codefile \"shell\" %q}}" .ImportFile}}</code> 71 to 72 <code>{{codefile "shell" .ImportFile}}</code> (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/300">#300</a>)</li> 73 </ul> 74 <p>FEATURES:</p> 75 <ul> 76 <li>migrate: Added new <code>migrate</code> subcommand that migrates existing provider docs using the rendered website source directories (<code>website/docs/</code> or <code>/docs/</code>) to a <code>terraform-plugin-docs</code>-supported templates directory. (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/314">#314</a>)</li> 77 </ul> 78 <p>ENHANCEMENTS:</p> 79 <ul> 80 <li>generate: Add <code>provider-schema</code> flag to pass in a file path to a provider schema JSON file, allowing the command to skip building the provider and calling Terraform CLI (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/299">#299</a>)</li> 81 </ul> 82 <p>BUG FIXES:</p> 83 <ul> 84 <li>generate: fix <code>no such file or directory</code> error when running <code>generate</code> with no existing rendered website directory. (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/296">#296</a>)</li> 85 <li>generate: fix incorrect rendering of example and import files for providers with no docs templates or with generic fallback templates. (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/300">#300</a>)</li> 86 </ul> 87 </blockquote> 88 </details> 89 <details> 90 <summary>Commits</summary> 91 <ul> 92 <li><a href="https://github.com/hashicorp/terraform-plugin-docs/commit/4c08c0eed13b3819b4342dc0cb119b3be62305b1"><code>4c08c0e</code></a> Update changelog</li> 93 <li><a href="https://github.com/hashicorp/terraform-plugin-docs/commit/69163cd34b1dd82989d338020dcf066e779b6f34"><code>69163cd</code></a> Add Support for Provider-defined Function Documentation (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/328">#328</a>)</li> 94 <li><a href="https://github.com/hashicorp/terraform-plugin-docs/commit/56c7fae74f885ee2e2bc5348035d62c72687f9e0"><code>56c7fae</code></a> Bump github.com/hashicorp/terraform-json from 0.20.0 to 0.21.0 (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/325">#325</a>)</li> 95 <li><a href="https://github.com/hashicorp/terraform-plugin-docs/commit/1856bda3cf43d608c6c127c6bce8b841a0737172"><code>1856bda</code></a> Update changelog</li> 96 <li><a href="https://github.com/hashicorp/terraform-plugin-docs/commit/6dec712fb402921fab6a6fca383e908bbb52bb2b"><code>6dec712</code></a> Bump github.com/rogpeppe/go-internal from 1.11.0 to 1.12.0 (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/306">#306</a>)</li> 97 <li><a href="https://github.com/hashicorp/terraform-plugin-docs/commit/042eb55cb3191282e8ffbae2cd05474eee609845"><code>042eb55</code></a> Document the default behavior of <code>--tf-version</code> and usage of Terraform binary...</li> 98 <li><a href="https://github.com/hashicorp/terraform-plugin-docs/commit/2e13971edd11385e94c2f18a9d524651dbd642e9"><code>2e13971</code></a> deps: Migrate to github.com/hashicorp/cli (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/322">#322</a>)</li> 99 <li><a href="https://github.com/hashicorp/terraform-plugin-docs/commit/eff4087f0c37ea25f8d032ccf87d0d833f4dc45f"><code>eff4087</code></a> Update README.md - add <code>tools.go</code> quick example (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/289">#289</a>)</li> 100 <li><a href="https://github.com/hashicorp/terraform-plugin-docs/commit/068a22697e08a30c09544e0e5a3715d7b744b1d7"><code>068a226</code></a> Implement <code>migrate</code> sub-command (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/314">#314</a>)</li> 101 <li><a href="https://github.com/hashicorp/terraform-plugin-docs/commit/8456c0cd9e8a124a6b2f7387fa064be8341b8ee9"><code>8456c0c</code></a> Bump github.com/hashicorp/terraform-json from 0.18.0 to 0.20.0 (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/315">#315</a>)</li> 102 <li>Additional commits viewable in <a href="https://github.com/hashicorp/terraform-plugin-docs/compare/v0.16.0...v0.18.0">compare view</a></li> 103 </ul> 104 </details> 105 <br /> 106 107 108 [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) 109 110 Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. 111 112 [//]: # (dependabot-automerge-start) 113 [//]: # (dependabot-automerge-end) 114 115 --- 116 117 <details> 118 <summary>Dependabot commands and options</summary> 119 <br /> 120 121 You can trigger Dependabot actions by commenting on this PR: 122 - `@dependabot rebase` will rebase this PR 123 - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it 124 - `@dependabot merge` will merge this PR after your CI passes on it 125 - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it 126 - `@dependabot cancel merge` will cancel a previously requested merge and block automerging 127 - `@dependabot reopen` will reopen this PR if it is closed 128 - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually 129 - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency 130 - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) 131 - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) 132 - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) 133 134 135 </details> 136