2.md (9471B)
1 # PR #2 Bump github.com/hashicorp/terraform-plugin-docs from 0.16.0 to 0.17.0 2 3 - **Status:** closed 4 - **Author:** @dependabot[bot] 5 - **Created:** 2024-01-18T03:07:12Z 6 - **Branch:** dependabot/go_modules/github.com/hashicorp/terraform-plugin-docs-0.17.0 → main 7 - **Closed:** 2024-01-25T02:46:39Z 8 - **Labels:** dependencies 9 - **Diff:** [2.diff](./2.diff) 10 11 --- 12 13 Bumps [github.com/hashicorp/terraform-plugin-docs](https://github.com/hashicorp/terraform-plugin-docs) from 0.16.0 to 0.17.0. 14 <details> 15 <summary>Release notes</summary> 16 <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> 17 <blockquote> 18 <h2>v0.17.0</h2> 19 <p>BREAKING CHANGES:</p> 20 <ul> 21 <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. 22 For example, switch the following template code: 23 <code>{{printf "{{codefile \"shell\" %q}}" .ImportFile}}</code> 24 to 25 <code>{{codefile "shell" .ImportFile}}</code> (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/300">#300</a>)</li> 26 </ul> 27 <p>FEATURES:</p> 28 <ul> 29 <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> 30 </ul> 31 <p>ENHANCEMENTS:</p> 32 <ul> 33 <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> 34 </ul> 35 <p>BUG FIXES:</p> 36 <ul> 37 <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> 38 <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> 39 </ul> 40 </blockquote> 41 </details> 42 <details> 43 <summary>Changelog</summary> 44 <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> 45 <blockquote> 46 <h2>0.17.0 (January 17, 2024)</h2> 47 <p>BREAKING CHANGES:</p> 48 <ul> 49 <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. 50 For example, switch the following template code: 51 <code>{{printf "{{codefile \"shell\" %q}}" .ImportFile}}</code> 52 to 53 <code>{{codefile "shell" .ImportFile}}</code> (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/300">#300</a>)</li> 54 </ul> 55 <p>FEATURES:</p> 56 <ul> 57 <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> 58 </ul> 59 <p>ENHANCEMENTS:</p> 60 <ul> 61 <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> 62 </ul> 63 <p>BUG FIXES:</p> 64 <ul> 65 <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> 66 <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> 67 </ul> 68 </blockquote> 69 </details> 70 <details> 71 <summary>Commits</summary> 72 <ul> 73 <li><a href="https://github.com/hashicorp/terraform-plugin-docs/commit/1856bda3cf43d608c6c127c6bce8b841a0737172"><code>1856bda</code></a> Update changelog</li> 74 <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> 75 <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> 76 <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> 77 <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> 78 <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> 79 <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> 80 <li><a href="https://github.com/hashicorp/terraform-plugin-docs/commit/8b2a7060df3c3063c29598f463b95b84e703f2f1"><code>8b2a706</code></a> Bump github.com/hashicorp/terraform-exec from 0.19.0 to 0.20.0 (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/313">#313</a>)</li> 81 <li><a href="https://github.com/hashicorp/terraform-plugin-docs/commit/de5265bad545a16620a5401e8fa1e80c61681373"><code>de5265b</code></a> Bump github.com/cloudflare/circl from 1.3.3 to 1.3.7 (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/319">#319</a>)</li> 82 <li><a href="https://github.com/hashicorp/terraform-plugin-docs/commit/0db8e4f7d0b6c94e5d247a9257268e27ef96fdbe"><code>0db8e4f</code></a> Bump github.com/cloudflare/circl from 1.3.3 to 1.3.7 in /tools (<a href="https://redirect.github.com/hashicorp/terraform-plugin-docs/issues/320">#320</a>)</li> 83 <li>Additional commits viewable in <a href="https://github.com/hashicorp/terraform-plugin-docs/compare/v0.16.0...v0.17.0">compare view</a></li> 84 </ul> 85 </details> 86 <br /> 87 88 89 [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) 90 91 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`. 92 93 [//]: # (dependabot-automerge-start) 94 [//]: # (dependabot-automerge-end) 95 96 --- 97 98 <details> 99 <summary>Dependabot commands and options</summary> 100 <br /> 101 102 You can trigger Dependabot actions by commenting on this PR: 103 - `@dependabot rebase` will rebase this PR 104 - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it 105 - `@dependabot merge` will merge this PR after your CI passes on it 106 - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it 107 - `@dependabot cancel merge` will cancel a previously requested merge and block automerging 108 - `@dependabot reopen` will reopen this PR if it is closed 109 - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually 110 - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency 111 - `@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) 112 - `@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) 113 - `@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) 114 115 116 </details> 117 118 119 ## Comments 120 121 ### @dependabot[bot] — 2024-01-25T02:46:38Z 122 123 Superseded by #3. 124