SemanticRelease

0.1.0-preview

en-US/SemanticRelease-Help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" schema="maml" xmlns="http://msh">

  <command:command>

    <command:details>

      <command:name>Get-SemanticReleaseCommitMessage</command:name>

      <maml:description>

        <maml:para>Collects Git commit messages for semantic-release analysis.</maml:para>

      </maml:description>

      <command:verb>Get</command:verb>

      <command:noun>SemanticReleaseCommitMessage</command:noun>

    </command:details>

    <maml:description>

      <maml:para>Use this cmdlet to read commit messages from the target Git repository using the semantic-release log format `%s%n%b%n--END-COMMIT--`.

If a version tag exists, the cmdlet reads commits from `tag..HEAD`.

If no tag exists, it reads the full commit history visible from `HEAD`.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-SemanticReleaseCommitMessage</maml:name>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">

          <maml:name>ProjectRoot</maml:name>

          <maml:description />

          <command:parameterValue required="true" variableLength="false">string</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

          </dev:type>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">

        <maml:name>ProjectRoot</maml:name>

        <maml:description>

          <maml:para>Specifies the repository root to inspect. The default value is the current working directory.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

      </command:parameter>

    </command:parameters>

    <command:inputTypes />

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.String[]</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>Returns trimmed commit-message entries with blank delimiter blocks removed.</maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>- The cmdlet preserves the release-parser delimiter and split behavior used by the underlying private helpers.

- A non-repository path returns an empty collection.</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>--------- Example 1 ---------</maml:title>

        <maml:introduction>

          <maml:para>Collect commit messages since the most recent version tag.</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>```powershell

PS&gt; Get-SemanticReleaseCommitMessage</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>feat: add preview release support

fix: preserve prerelease finalization behavior

```</maml:para>

        </maml:introduction>

        <dev:code />

        <dev:remarks />

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Online Version</maml:linkText>

        <maml:uri />

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Get-SemanticReleaseCommitRange</maml:linkText>

        <maml:uri>./Get-SemanticReleaseCommitRange.md</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Get-SemanticReleaseLabel</maml:linkText>

        <maml:uri>./Get-SemanticReleaseLabel.md</maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

  <command:command>

    <command:details>

      <command:name>Get-SemanticReleaseCommitRange</command:name>

      <maml:description>

        <maml:para>Detects the last version tag in a Git repository and returns the commit-range basis for semantic release calculations.</maml:para>

      </maml:description>

      <command:verb>Get</command:verb>

      <command:noun>SemanticReleaseCommitRange</command:noun>

    </command:details>

    <maml:description>

      <maml:para>Use this cmdlet to determine whether the target path is a Git repository, whether a version tag is present, and which revision range should be used for release analysis.

When a tag is found, the cmdlet returns the exact `tag..HEAD` range used by the release helpers.

When no tag is found, the cmdlet reports repository scope without a revision range so downstream commands can evaluate the full history.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-SemanticReleaseCommitRange</maml:name>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">

          <maml:name>ProjectRoot</maml:name>

          <maml:description />

          <command:parameterValue required="true" variableLength="false">string</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

          </dev:type>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">

        <maml:name>ProjectRoot</maml:name>

        <maml:description>

          <maml:para>Specifies the repository root to inspect. The default value is the current working directory.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

      </command:parameter>

    </command:parameters>

    <command:inputTypes />

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.Management.Automation.PSCustomObject</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>Returns a range-basis object with `ProjectRoot`, `IsRepository`, `HasVersionTag`, `LastTag`, and `RevisionRange` properties.</maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>- The cmdlet uses `git describe --tags --abbrev=0` to locate the most recent version tag.

- If Git is unavailable or the path is not a repository, `IsRepository` is `$false`.</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>--------- Example 1 ---------</maml:title>

        <maml:introduction>

          <maml:para>Detect the current semantic-release range for the repository in the working directory.</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>```powershell

PS&gt; Get-SemanticReleaseCommitRange</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>ProjectRoot    : /Users/example/SemanticRelease

IsRepository   : True

HasVersionTag  : True

LastTag        : v1.2.3

RevisionRange  : v1.2.3..HEAD

```</maml:para>

        </maml:introduction>

        <dev:code />

        <dev:remarks />

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Online Version</maml:linkText>

        <maml:uri />

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Get-SemanticReleaseCommitMessage</maml:linkText>

        <maml:uri>./Get-SemanticReleaseCommitMessage.md</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Get-SemanticReleaseLabel</maml:linkText>

        <maml:uri>./Get-SemanticReleaseLabel.md</maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

  <command:command>

    <command:details>

      <command:name>Get-SemanticReleaseLabel</command:name>

      <maml:description>

        <maml:para>Infers a semantic-release label from commit messages.</maml:para>

      </maml:description>

      <command:verb>Get</command:verb>

      <command:noun>SemanticReleaseLabel</command:noun>

    </command:details>

    <maml:description>

      <maml:para>Use this cmdlet to map Conventional Commit messages to a semantic-release label.

Breaking changes resolve to `Major`, `feat` commits resolve to `Minor`, and `fix` commits resolve to `Patch`.

Unmatched commit sets also default to `Patch`.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-SemanticReleaseLabel</maml:name>

        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">

          <maml:name>Message</maml:name>

          <maml:description />

          <command:parameterValue required="true" variableLength="false">string[]</command:parameterValue>

          <dev:type>

            <maml:name>System.String[]</maml:name>

          </dev:type>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">

        <maml:name>Message</maml:name>

        <maml:description>

          <maml:para>Specifies the commit messages to evaluate.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="true">System.String[]</command:parameterValue>

        <dev:type>

          <maml:name>System.String[]</maml:name>

        </dev:type>

      </command:parameter>

    </command:parameters>

    <command:inputTypes />

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>Returns `Major`, `Minor`, or `Patch`.</maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>- The cmdlet recognizes both `BREAKING CHANGE` footers and Conventional Commit `!` markers as major-version triggers.

- Messages are matched case-insensitively.</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>--------- Example 1 ---------</maml:title>

        <maml:introduction>

          <maml:para>Infer a label from a collected commit set.</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>```powershell

PS&gt; Get-SemanticReleaseLabel -Message @(

&gt;&gt;     'feat: add release plan command'

&gt;&gt;     'fix: preserve preview numbering'

&gt;&gt; )</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>Minor

```</maml:para>

        </maml:introduction>

        <dev:code />

        <dev:remarks />

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Online Version</maml:linkText>

        <maml:uri />

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Get-SemanticReleaseCommitMessage</maml:linkText>

        <maml:uri>./Get-SemanticReleaseCommitMessage.md</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Get-SemanticReleaseNextVersion</maml:linkText>

        <maml:uri>./Get-SemanticReleaseNextVersion.md</maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

  <command:command>

    <command:details>

      <command:name>Get-SemanticReleaseNextVersion</command:name>

      <maml:description>

        <maml:para>Calculates the next semantic version from a current version and release label.</maml:para>

      </maml:description>

      <command:verb>Get</command:verb>

      <command:noun>SemanticReleaseNextVersion</command:noun>

    </command:details>

    <maml:description>

      <maml:para>Use this cmdlet to build the next semantic version plan for stable or preview releases.

Stable releases increment the requested version part, except when finalizing an existing prerelease for the same target label.

Preview releases preserve existing prerelease targets and increment the preview label, or start a new preview from the next patch version when the current version is stable.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-SemanticReleaseNextVersion</maml:name>

        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">

          <maml:name>CurrentVersion</maml:name>

          <maml:description />

          <command:parameterValue required="true" variableLength="false">semver</command:parameterValue>

          <dev:type>

            <maml:name>System.Management.Automation.SemanticVersion</maml:name>

          </dev:type>

        </command:parameter>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">

          <maml:name>Label</maml:name>

          <maml:description />

          <command:parameterValue required="true" variableLength="false">string</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

          </dev:type>

        </command:parameter>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">

          <maml:name>PreviewRelease</maml:name>

          <maml:description />

          <dev:type>

            <maml:name>System.Management.Automation.SwitchParameter</maml:name>

          </dev:type>

        </command:parameter>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">

          <maml:name>StableRelease</maml:name>

          <maml:description />

          <dev:type>

            <maml:name>System.Management.Automation.SwitchParameter</maml:name>

          </dev:type>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">

        <maml:name>CurrentVersion</maml:name>

        <maml:description>

          <maml:para>Specifies the current semantic version.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="true">System.Management.Automation.SemanticVersion</command:parameterValue>

        <dev:type>

          <maml:name>System.Management.Automation.SemanticVersion</maml:name>

        </dev:type>

      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">

        <maml:name>Label</maml:name>

        <maml:description>

          <maml:para>Specifies which semantic version part to target. Valid values are `Major`, `Minor`, and `Patch`.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">

        <maml:name>PreviewRelease</maml:name>

        <maml:description>

          <maml:para>Indicates that the next version should be a preview release.</maml:para>

        </maml:description>

        <dev:type>

          <maml:name>System.Management.Automation.SwitchParameter</maml:name>

        </dev:type>

      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none">

        <maml:name>StableRelease</maml:name>

        <maml:description>

          <maml:para>Indicates that the next version should be emitted without a prerelease label.</maml:para>

        </maml:description>

        <dev:type>

          <maml:name>System.Management.Automation.SwitchParameter</maml:name>

        </dev:type>

      </command:parameter>

    </command:parameters>

    <command:inputTypes />

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.Management.Automation.PSCustomObject</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>Returns a version-plan object with `CurrentVersion`, `Label`, `PreviewRelease`, `StableRelease`, and `NewVersion` properties.</maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>- Version construction uses `[semver]::new(major, minor, patch, releaseType, $null)`.

- Preview numbering starts at `preview01` and preserves zero-padding width on multi-digit suffixes.</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>--------- Example 1 ---------</maml:title>

        <maml:introduction>

          <maml:para>Calculate the next stable minor release.</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>```powershell

PS&gt; Get-SemanticReleaseNextVersion -CurrentVersion ([semver]'1.2.3') -Label Minor</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>CurrentVersion : 1.2.3

Label          : Minor

PreviewRelease : False

StableRelease  : False

NewVersion     : 1.3.0

```</maml:para>

        </maml:introduction>

        <dev:code />

        <dev:remarks />

      </command:example>

      <command:example>

        <maml:title>--------- Example 2 ---------</maml:title>

        <maml:introduction>

          <maml:para>Continue an existing preview release without changing the version parts.</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>```powershell

PS&gt; Get-SemanticReleaseNextVersion -CurrentVersion ([semver]'1.2.3-preview01') -Label Patch -PreviewRelease</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>CurrentVersion : 1.2.3-preview01

Label          : Patch

PreviewRelease : True

StableRelease  : False

NewVersion     : 1.2.3-preview02

```</maml:para>

        </maml:introduction>

        <dev:code />

        <dev:remarks />

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Online Version</maml:linkText>

        <maml:uri />

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Get-SemanticReleaseLabel</maml:linkText>

        <maml:uri>./Get-SemanticReleaseLabel.md</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Set-SemanticReleaseJsonVersion</maml:linkText>

        <maml:uri>./Set-SemanticReleaseJsonVersion.md</maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

  <command:command>

    <command:details>

      <command:name>Set-SemanticReleaseJsonVersion</command:name>

      <maml:description>

        <maml:para>Updates a semantic version key in a JSON file using semantic-release version rules.</maml:para>

      </maml:description>

      <command:verb>Set</command:verb>

      <command:noun>SemanticReleaseJsonVersion</command:noun>

    </command:details>

    <maml:description>

      <maml:para>Use this cmdlet to read a top-level version value from a JSON file, calculate the next semantic version, and write the updated value back to the file.

The cmdlet reads JSON with `ConvertFrom-Json -AsHashtable`, writes JSON with `ConvertTo-Json -Depth 20`, and supports `ShouldProcess` for safe preview runs.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Set-SemanticReleaseJsonVersion</maml:name>

        <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">

          <maml:name>Path</maml:name>

          <maml:description />

          <command:parameterValue required="true" variableLength="false">string</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

          </dev:type>

        </command:parameter>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">

          <maml:name>Key</maml:name>

          <maml:description />

          <command:parameterValue required="true" variableLength="false">string</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

          </dev:type>

        </command:parameter>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none">

          <maml:name>Label</maml:name>

          <maml:description />

          <command:parameterValue required="true" variableLength="false">string</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

          </dev:type>

        </command:parameter>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases="none">

          <maml:name>ReleaseType</maml:name>

          <maml:description />

          <command:parameterValue required="true" variableLength="false">string</command:parameterValue>

          <dev:type>

            <maml:name>System.String</maml:name>

          </dev:type>

        </command:parameter>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">

          <maml:name>WhatIf</maml:name>

          <maml:description />

          <dev:type>

            <maml:name>System.Management.Automation.SwitchParameter</maml:name>

          </dev:type>

        </command:parameter>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none">

          <maml:name>Confirm</maml:name>

          <maml:description />

          <dev:type>

            <maml:name>System.Management.Automation.SwitchParameter</maml:name>

          </dev:type>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="cf">

        <maml:name>Confirm</maml:name>

        <maml:description>

          <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>

        </maml:description>

        <dev:type>

          <maml:name>System.Management.Automation.SwitchParameter</maml:name>

        </dev:type>

      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases="none">

        <maml:name>Key</maml:name>

        <maml:description>

          <maml:para>Specifies the top-level JSON key that contains the semantic version. The default value is `Version`.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases="none">

        <maml:name>Label</maml:name>

        <maml:description>

          <maml:para>Specifies which semantic version part to target. Valid values are `Major`, `Minor`, and `Patch`.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

      </command:parameter>

      <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none">

        <maml:name>Path</maml:name>

        <maml:description>

          <maml:para>Specifies the JSON file to update.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases="none">

        <maml:name>ReleaseType</maml:name>

        <maml:description>

          <maml:para>Specifies how the cmdlet should emit the next version. Valid values are `Default`, `Preview`, and `Stable`.</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue>

        <dev:type>

          <maml:name>System.String</maml:name>

        </dev:type>

      </command:parameter>

      <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="wi">

        <maml:name>WhatIf</maml:name>

        <maml:description>

          <maml:para>Runs the command in a mode that only reports what would happen without performing the actions.</maml:para>

        </maml:description>

        <dev:type>

          <maml:name>System.Management.Automation.SwitchParameter</maml:name>

        </dev:type>

      </command:parameter>

    </command:parameters>

    <command:inputTypes />

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.Management.Automation.PSCustomObject</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>Returns a result object with `Path`, `Target`, `Key`, `PreviousVersion`, `NewVersion`, and `Applied` properties.</maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para>- The cmdlet updates only top-level JSON keys.

- If the specified key is missing, the cmdlet throws.</maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>--------- Example 1 ---------</maml:title>

        <maml:introduction>

          <maml:para>Preview a patch update for the default `Version` key.</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>```powershell

PS&gt; Set-SemanticReleaseJsonVersion -Path ./project.json -ReleaseType Preview -WhatIf

What if: Performing the operation "Set Version to 0.1.1" on target "project.json".

```</maml:para>

        </maml:introduction>

        <dev:code />

        <dev:remarks />

      </command:example>

      <command:example>

        <maml:title>--------- Example 2 ---------</maml:title>

        <maml:introduction>

          <maml:para>Update a custom version key in a JSON file.</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>```powershell

PS&gt; Set-SemanticReleaseJsonVersion -Path ./package.json -Key Version -Label Minor -Confirm:$false</maml:para>

          <maml:para>&#x80;</maml:para>

          <maml:para>Path            : ./package.json

Target          : package.json

Key             : Version

PreviousVersion : 1.2.3

NewVersion      : 1.3.0

Applied         : True

```</maml:para>

        </maml:introduction>

        <dev:code />

        <dev:remarks />

      </command:example>

    </command:examples>

    <command:relatedLinks>

      <maml:navigationLink>

        <maml:linkText>Online Version</maml:linkText>

        <maml:uri />

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Get-SemanticReleaseNextVersion</maml:linkText>

        <maml:uri>./Get-SemanticReleaseNextVersion.md</maml:uri>

      </maml:navigationLink>

      <maml:navigationLink>

        <maml:linkText>Get-SemanticReleaseLabel</maml:linkText>

        <maml:uri>./Get-SemanticReleaseLabel.md</maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

</helpItems>