GitEasy

« All commands

New-Release Mark the current saved point as a named release version.

Read / Write GitEasy v1.5.3

Description

New-Release creates a permanent, annotated marker at the current saved point - the GitEasy term for what Git calls an "annotated tag". Use it to stamp a release version (v1.0.0, v1.5.0, etc.) with a note that travels alongside the project.

By default, New-Release also publishes the marker to the project's published location. Use -NoPush to keep it local. If a release of the same version already exists, New-Release refuses to overwrite unless you pass -Force.

Each invocation writes a self-contained diagnostic log file. Successful runs log silently; failures throw a plain-English message and point at the log file with the technical detail.

Recipes

Recipe 1
EXAMPLE 1
New-Release -Version v1.5.0 -Note 'Phase 15 complete: ...'
Recipe 2
EXAMPLE 2
New-Release v1.5.0 'phase 15' -NoPush
Recipe 3
EXAMPLE 3
New-Release -Version v1.5.0 -Note 'corrected release note' -Force

Notes

Safety:

Parameters

-Version required String
The release version name. Conventional format is `v` followed by major.minor.patch (for example, `v1.5.0`), but any valid name is accepted.
-Note required String
A short message describing the release. Travels permanently with the marker; appears in `Show-Releases` output.
-NoPush optional SwitchParameter
Create the release marker locally only. Do not publish.
-Force optional SwitchParameter
Overwrite an existing release of the same version. Without -Force, New-Release refuses to clobber an existing release.
-LogPath optional String
Override the directory where the diagnostic log for this run is written.
-WhatIf optional SwitchParameter
-Confirm optional SwitchParameter

Was this page helpful? Report an issue or suggest an improvement →