|
144 | 144 | </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>--message</code>, <code>-m</code></td> <td>text</td> <td>The changelog text</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> <h4 id=ddev-release-changelog-show>ddev release changelog show<a class=headerlink href=#ddev-release-changelog-show title="Permanent link">¶</a></h4> <p>Print the section of TARGET's CHANGELOG.md that corresponds to VERSION.</p> <p>The output is the markdown content between the <code>## VERSION</code> heading and the next <code>##</code> heading, with surrounding blank lines stripped. Useful for populating GitHub release notes from the just-built changelog.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev release changelog show [OPTIONS] TARGET VERSION |
145 | 145 | </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>--file</code>, <code>-f</code></td> <td>file</td> <td>Write the extracted section to this file (overwrites if it exists) instead of stdout</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> <h3 id=ddev-release-list>ddev release list<a class=headerlink href=#ddev-release-list title="Permanent link">¶</a></h3> <p>Show all versions of an integration.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev release list [OPTIONS] INTEGRATION |
146 | 146 | </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-release-make>ddev release make<a class=headerlink href=#ddev-release-make title="Permanent link">¶</a></h3> <p>Perform a set of operations needed to release checks:</p> <ul> <li>update the version in <code>__about__.py</code></li> <li>update the changelog</li> <li>update the <code>requirements-agent-release.txt</code> file</li> <li>update in-toto metadata</li> <li>commit the above changes</li> </ul> <p>You can release everything at once by setting the check to <code>all</code>.</p> <p>If you run into issues signing: - Ensure you did <code>gpg --import <YOUR_KEY_ID>.gpg.pub</code></p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev release make [OPTIONS] CHECKS... |
147 | | -</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>--version</code></td> <td>text</td> <td>N/A</td> <td>None</td> </tr> <tr> <td><code>--end</code></td> <td>text</td> <td>N/A</td> <td>None</td> </tr> <tr> <td><code>--new</code></td> <td>boolean</td> <td>Ensure versions are at 1.0.0</td> <td><code>False</code></td> </tr> <tr> <td><code>--skip-sign</code></td> <td>boolean</td> <td>Skip the signing of release metadata</td> <td><code>False</code></td> </tr> <tr> <td><code>--sign-only</code></td> <td>boolean</td> <td>Only sign release metadata</td> <td><code>False</code></td> </tr> <tr> <td><code>--exclude</code></td> <td>text</td> <td>Comma-separated list of checks to skip</td> <td>None</td> </tr> <tr> <td><code>--allow-master</code></td> <td>boolean</td> <td>Allow ddev to commit directly to master. Forbidden for core.</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> <h3 id=ddev-release-port-commit>ddev release port-commit<a class=headerlink href=#ddev-release-port-commit title="Permanent link">¶</a></h3> <p>Backport a commit onto a target branch.</p> <p>Cherry-picks COMMIT_OR_PR onto <code>--target-branch</code> (default <code>master</code>) on a new branch named <code><github-user>/<prefix>-<sha[:10]>-<suffix></code>, preserving <code>.in-toto</code> files from the target branch so package signatures stay intact. Pushes the branch and, unless <code>--no-pr</code> is set, opens a pull request titled <code>[Backport] <subject></code> and labeled with <code>--pr-labels</code>.</p> <p>COMMIT_OR_PR accepts: a full 40-character commit SHA, a PR number (e.g. <code>23703</code>), an explicit <code>PR-<number></code> token, or a GitHub PR URL. Pure-digit inputs are tried as a PR first when a GitHub token is configured, and fall back to commit resolution on 404. If omitted, the current HEAD commit is used after confirmation.</p> <p>The GitHub user for the branch prefix is taken from <code>ddev config</code> (<code>github.user</code>) or the <code>DD_GITHUB_USER</code> / <code>GITHUB_USER</code> / <code>GITHUB_ACTOR</code> environment variables.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev release port-commit [OPTIONS] COMMIT_OR_PR |
148 | | -</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>-t</code>, <code>--target-branch</code></td> <td>text</td> <td>Target branch to port to.</td> <td><code>master</code></td> </tr> <tr> <td><code>-p</code>, <code>--branch-prefix</code></td> <td>text</td> <td>Branch name prefix.</td> <td><code>port</code></td> </tr> <tr> <td><code>-s</code>, <code>--branch-suffix</code></td> <td>text</td> <td>Branch name suffix. Defaults to <code>to-<target-branch></code>.</td> <td>None</td> </tr> <tr> <td><code>-l</code>, <code>--pr-labels</code></td> <td>text</td> <td>Comma-separated PR labels.</td> <td><code>qa/skip-qa</code></td> </tr> <tr> <td><code>--no-pr</code></td> <td>boolean</td> <td>Don't create a pull request.</td> <td><code>False</code></td> </tr> <tr> <td><code>--draft</code></td> <td>boolean</td> <td>Open the PR as a draft.</td> <td><code>False</code></td> </tr> <tr> <td><code>--verify</code></td> <td>boolean</td> <td>Run commit hooks (skipped by default).</td> <td><code>False</code></td> </tr> <tr> <td><code>--dry-run</code></td> <td>boolean</td> <td>Print every step instead of executing it.</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> <h3 id=ddev-release-show>ddev release show<a class=headerlink href=#ddev-release-show title="Permanent link">¶</a></h3> <p>To avoid GitHub's public API rate limits, you need to set <code>github.user</code>/<code>github.token</code> in your config file or use the <code>DD_GITHUB_USER</code>/<code>DD_GITHUB_TOKEN</code> environment variables.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev release show [OPTIONS] COMMAND [ARGS]... |
| 147 | +</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>--version</code></td> <td>text</td> <td>N/A</td> <td>None</td> </tr> <tr> <td><code>--end</code></td> <td>text</td> <td>N/A</td> <td>None</td> </tr> <tr> <td><code>--new</code></td> <td>boolean</td> <td>Ensure versions are at 1.0.0</td> <td><code>False</code></td> </tr> <tr> <td><code>--skip-sign</code></td> <td>boolean</td> <td>Skip the signing of release metadata</td> <td><code>False</code></td> </tr> <tr> <td><code>--sign-only</code></td> <td>boolean</td> <td>Only sign release metadata</td> <td><code>False</code></td> </tr> <tr> <td><code>--exclude</code></td> <td>text</td> <td>Comma-separated list of checks to skip</td> <td>None</td> </tr> <tr> <td><code>--allow-master</code></td> <td>boolean</td> <td>Allow ddev to commit directly to master. Forbidden for core.</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> <h3 id=ddev-release-port-commit>ddev release port-commit<a class=headerlink href=#ddev-release-port-commit title="Permanent link">¶</a></h3> <p>Backport a commit onto a target branch.</p> <p>Cherry-picks COMMIT_OR_PR onto <code>--target-branch</code> (default <code>master</code>) on a new branch named <code><github-user>/<prefix>-<sha[:10]>-<suffix></code>, preserving <code>.in-toto</code> and <code>.deps/</code> files from the target branch so package signatures stay intact. Pushes the branch and, unless <code>--no-pr</code> is set, opens a pull request titled <code>[Backport] <subject></code> and labeled with <code>--pr-labels</code>.</p> <p>COMMIT_OR_PR accepts: a full 40-character commit SHA, a PR number (e.g. <code>23703</code>), an explicit <code>PR-<number></code> token, or a GitHub PR URL. Pure-digit inputs are tried as a PR first when a GitHub token is configured, and fall back to commit resolution on 404. If omitted, the current HEAD commit is used after confirmation.</p> <p>Pass <code>--from-pr <number></code> instead of COMMIT_OR_PR to backport a merged PR to every <code>backport/<base></code> label on it, deriving the commit and target branches from the PR. A base whose backport PR already exists (open, merged, or closed) is skipped, so re-runs are idempotent. Give <code>--target-branch</code> alongside <code>--from-pr</code> to restrict the backport to that one branch.</p> <p>The GitHub user for the branch prefix is taken from <code>ddev config</code> (<code>github.user</code>) or the <code>DD_GITHUB_USER</code> / <code>GITHUB_USER</code> / <code>GITHUB_ACTOR</code> environment variables.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev release port-commit [OPTIONS] COMMIT_OR_PR |
| 148 | +</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>-t</code>, <code>--target-branch</code></td> <td>text</td> <td>Target branch to port to.</td> <td><code>master</code></td> </tr> <tr> <td><code>-p</code>, <code>--branch-prefix</code></td> <td>text</td> <td>Branch name prefix.</td> <td><code>port</code></td> </tr> <tr> <td><code>-s</code>, <code>--branch-suffix</code></td> <td>text</td> <td>Branch name suffix. Defaults to <code>to-<target-branch></code>.</td> <td>None</td> </tr> <tr> <td><code>-l</code>, <code>--pr-labels</code></td> <td>text</td> <td>Comma-separated PR labels.</td> <td><code>qa/skip-qa</code></td> </tr> <tr> <td><code>--no-pr</code></td> <td>boolean</td> <td>Don't create a pull request.</td> <td><code>False</code></td> </tr> <tr> <td><code>--draft</code></td> <td>boolean</td> <td>Open the PR as a draft.</td> <td><code>False</code></td> </tr> <tr> <td><code>--verify</code></td> <td>boolean</td> <td>Run commit hooks (skipped by default).</td> <td><code>False</code></td> </tr> <tr> <td><code>--dry-run</code></td> <td>boolean</td> <td>Print every step instead of executing it.</td> <td><code>False</code></td> </tr> <tr> <td><code>--from-pr</code></td> <td>integer</td> <td>Backport a merged PR to every <code>backport/<base></code> label on it, deriving the commit and target branches from the PR. Mutually exclusive with COMMIT_OR_PR.</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> <h3 id=ddev-release-show>ddev release show<a class=headerlink href=#ddev-release-show title="Permanent link">¶</a></h3> <p>To avoid GitHub's public API rate limits, you need to set <code>github.user</code>/<code>github.token</code> in your config file or use the <code>DD_GITHUB_USER</code>/<code>DD_GITHUB_TOKEN</code> environment variables.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev release show [OPTIONS] COMMAND [ARGS]... |
149 | 149 | </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> <h4 id=ddev-release-show-changes>ddev release show changes<a class=headerlink href=#ddev-release-show-changes title="Permanent link">¶</a></h4> <p>Show all the pending PRs for a given check.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev release show changes [OPTIONS] CHECK |
150 | 150 | </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>--tag-pattern</code></td> <td>text</td> <td>The regex pattern for the format of the tag. Required if the tag doesn't follow semver</td> <td>None</td> </tr> <tr> <td><code>--tag-prefix</code></td> <td>text</td> <td>Specify the prefix of the tag to use if the tag doesn't follow semver</td> <td>None</td> </tr> <tr> <td><code>--dry-run</code>, <code>-n</code></td> <td>boolean</td> <td>Run the command in dry-run mode</td> <td><code>False</code></td> </tr> <tr> <td><code>--since</code></td> <td>text</td> <td>The git ref to use instead of auto-detecting the tag to view changes since</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> <h4 id=ddev-release-show-ready>ddev release show ready<a class=headerlink href=#ddev-release-show-ready title="Permanent link">¶</a></h4> <p>Show all the checks that can be released.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev release show ready [OPTIONS] |
151 | 151 | </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>--quiet</code>, <code>-q</code></td> <td>boolean</td> <td>N/A</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> <h3 id=ddev-release-stats>ddev release stats<a class=headerlink href=#ddev-release-stats title="Permanent link">¶</a></h3> <p>A collection of tasks to generate reports about releases.</p> <p><strong>Usage:</strong></p> <div class=highlight><pre><span></span><code>ddev release stats [OPTIONS] COMMAND [ARGS]... |
|
0 commit comments