Improve messages around dependency spec management (#17969)

* Improve messages around dependency spec management

1. Validation says which commands can fix the failure.
2. Freeze/sync have docs that make it clear what they do and how they differ.
3. Freeze says what it's doing to the "static file"

* add changelog

* adjust test 3b646f7

Author: iliakur

ddev/cli/index.html

@@ -11,9 +11,9 @@
 </code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=ddev-config-show>ddev config show<a class=headerlink href=#ddev-config-show title="Permanent link">&para;</a></h3> <p>Show the contents of the config file.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev config show [OPTIONS]
 </code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--all</code>, <code>-a</code></td> <td>boolean</td> <td>Do not scrub secret fields</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=ddev-create>ddev create<a class=headerlink href=#ddev-create title="Permanent link">&para;</a></h2> <p>Create scaffolding for a new integration.</p> <p>NAME: The display name of the integration that will appear in documentation.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev create [OPTIONS] NAME
 </code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--type</code>, <code>-t</code></td> <td>choice (<code>check</code> &#x7C; <code>jmx</code> &#x7C; <code>logs</code> &#x7C; <code>metrics_crawler</code> &#x7C; <code>snmp_tile</code> &#x7C; <code>tile</code>)</td> <td>The type of integration to create</td> <td><code>check</code></td> </tr> <tr> <td><code>--location</code>, <code>-l</code></td> <td>text</td> <td>The directory where files will be written</td> <td>None</td> </tr> <tr> <td><code>--non-interactive</code>, <code>-ni</code></td> <td>boolean</td> <td>Disable prompting for fields</td> <td><code>False</code></td> </tr> <tr> <td><code>--quiet</code>, <code>-q</code></td> <td>boolean</td> <td>Show less output</td> <td><code>False</code></td> </tr> <tr> <td><code>--dry-run</code>, <code>-n</code></td> <td>boolean</td> <td>Only show what would be created</td> <td><code>False</code></td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=ddev-dep>ddev dep<a class=headerlink href=#ddev-dep title="Permanent link">&para;</a></h2> <p>Manage dependencies</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev dep [OPTIONS] COMMAND [ARGS]...
-</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=ddev-dep-freeze>ddev dep freeze<a class=headerlink href=#ddev-dep-freeze title="Permanent link">&para;</a></h3> <p>Combine all dependencies for the Agent's static environment.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev dep freeze [OPTIONS]
+</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=ddev-dep-freeze>ddev dep freeze<a class=headerlink href=#ddev-dep-freeze title="Permanent link">&para;</a></h3> <p>Combine all dependencies for the Agent's static environment.</p> <p>This reads and merges the dependency specs from individual integrations and writes them to agent_requirements.in</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev dep freeze [OPTIONS]
 </code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=ddev-dep-pin>ddev dep pin<a class=headerlink href=#ddev-dep-pin title="Permanent link">&para;</a></h3> <p>Pin a dependency for all checks that require it.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev dep pin [OPTIONS] DEFINITION
-</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=ddev-dep-sync>ddev dep sync<a class=headerlink href=#ddev-dep-sync title="Permanent link">&para;</a></h3> <p>Update integrations' dependencies so that they match the Agent's static environment</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev dep sync [OPTIONS]
+</code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=ddev-dep-sync>ddev dep sync<a class=headerlink href=#ddev-dep-sync title="Permanent link">&para;</a></h3> <p>Synchronize integration dependency spec with that of the agent as a whole.</p> <p>Reads dependency spec from agent_requirements.in and propagates it to all integrations. For each integration we propagate only the relevant parts (i.e. its direct dependencies).</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev dep sync [OPTIONS]
 </code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=ddev-dep-updates>ddev dep updates<a class=headerlink href=#ddev-dep-updates title="Permanent link">&para;</a></h3> <p>Automatically check for dependency updates</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev dep updates [OPTIONS]
 </code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--sync</code>, <code>-s</code></td> <td>boolean</td> <td>Update the dependency definitions</td> <td><code>False</code></td> </tr> <tr> <td><code>--include-security-deps</code>, <code>-i</code></td> <td>boolean</td> <td>Attempt to update security dependencies</td> <td><code>False</code></td> </tr> <tr> <td><code>--batch-size</code>, <code>-b</code></td> <td>integer</td> <td>The maximum number of dependencies to upgrade if syncing</td> <td>None</td> </tr> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h2 id=ddev-docs>ddev docs<a class=headerlink href=#ddev-docs title="Permanent link">&para;</a></h2> <p>Manage documentation.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev docs [OPTIONS] COMMAND [ARGS]...
 </code></pre></div> <p><strong>Options:</strong></p> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> </thead> <tbody> <tr> <td><code>--help</code></td> <td>boolean</td> <td>Show this message and exit.</td> <td><code>False</code></td> </tr> </tbody> </table> <h3 id=ddev-docs-build>ddev docs build<a class=headerlink href=#ddev-docs-build title="Permanent link">&para;</a></h3> <p>Build documentation.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev docs build [OPTIONS]