Skip to content

updated docs to match actual parameter names for v6 steps #332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benPearce1 merged 1 commit into from
Nov 21, 2024
Merged

updated docs to match actual parameter names for v6 steps #332

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions source/vsts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Use this task to push your NuGet or Zip package to your Octopus Deploy Server. *
| :------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `OctoConnectedServiceName` | **Required.** The name of the Octopus Deploy [service connection](#Add-a-service-connection-to-Octopus-Deploy) |
| `Space` | **Required.** The space name within Octopus. |
| `Package` | **Required.** Multi-line list of packages to push to Octopus |
| `Packages` | **Required.** Multi-line list of packages to push to Octopus |
| `Replace` | Whether to replace the existing package(s). Valid options are true, false (default), IgnoreIfExists. If false is set the upload will fail if the package already exists. |

### 📤 Outputs
Expand Down Expand Up @@ -169,8 +169,8 @@ Options include:
| :------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `OctoConnectedServiceName` | **Required.** The name of the Octopus Deploy [service connection](#Add-a-service-connection-to-Octopus-Deploy) |
| `Space` | **Required.** The space name within Octopus. |
| `PackageId` | **Required.** Multi-line list of package Ids to push to Octopus. |
| `Version` | **Required.** The version of the package; must be a valid [SemVer](http://semver.org/) version. |
| `PackageIds` | **Required.** Multi-line list of package Ids to push to Octopus. |
| `PackageVersion` | **Required.** The version of the package; must be a valid [SemVer](http://semver.org/) version. |
| `Replace` | Determines the action to perform with build information if it already exists in the repository. Valid input values are `FailIfExists` (default), `OverwriteExisting`, and `IgnoreIfExists`. |

### 📤 Outputs
Expand All @@ -193,7 +193,8 @@ None.
| `Channel` | The [channel](https://g.octopushq.com/Channels) to use for the release. This must be the name of the channel, not the id. |
| `DefaultPackageVersion` | Set this to provide a default package version to use for all packages on all steps. Can be used in conjunction with the Packages field, which can be used to override versions for specific packages. |
| `Packages` | A multi-line list of version numbers to use for a package in the release. Format: `StepName:Version` or `PackageID:Version` or `StepName:PackageName:Version`. StepName, PackageID, and PackageName can be replaced with an asterisk ('\*'). An asterisk will be assumed for StepName, PackageID, or PackageName if they are omitted. |
| `CustomReleaseNotes` | Octopus Release notes. This field supports markdown. To include newlines, you can use HTML linebreaks. |
| `ReleaseNotes` | Octopus Release notes. This field supports markdown. To include newlines, you can use HTML linebreaks. Can only specify this if 'ReleaseNotesFile' is not supplied. |
Copy link
Contributor Author

@benPearce1 benPearce1 Nov 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is specific to v6 only, but v6 has been out for nearly 2 years

| `ReleaseNotesFile` | Octopus Release notes file. Path to a file that contains the release notes. Supports markdown. Can only specify this if 'ReleaseNotes' is not supplied. |
| `GitRef` | Git branch reference to use when creating the release for version controlled Projects. |
| `GitCommit` | Git commit to use when creating the release for version controlled Projects. Use in conjunction with the gitRef parameter to select any previous commit. |

Expand Down Expand Up @@ -236,6 +237,7 @@ From version 6, the deploy release step is split into two seperate functions for
| `ReleaseNumber` | **Required.** Release number for the new release. |
| `Environments` | **Required.** List of environments to deploy to, one environment per line. A comma-separated list of environments is also supported to ease migration from earlier versions for the step. |
| `Variables` | List of prompted variable values, one variable-value pair per line. Each variable should be in format `variable name: value` |
| `UseGuidedFailure` | Whether to use guided failure mode if errors occur during the deployment. |
| `AdditionalArguments` | Additional arguments are no longer supported. This field has been retained to ease migration from earlier versions of the step but values should be moved to the appropriate fields. |

#### 📤 Outputs
Expand All @@ -258,6 +260,7 @@ From version 6, the deploy release step is split into two seperate functions for
| `DeployForTenants` | List of tenant names to deploy for. One tenant name per line. |
| `DeployForTenantTags` | List of tenant tag names to deploy for. One tenant tag per line in the format `tag set name/tag name`. |
| `Variables` | List of prompted variable values, one variable-value pair per line. Each variable should be in format `variable name: value` |
| `UseGuidedFailure` | Whether to use guided failure mode if errors occur during the deployment. |
| `AdditionalArguments` | Additional arguments are no longer supported. This field has been retained to ease migration from earlier versions of the step but values should be moved to the appropriate fields. |

#### 📤 Outputs
Expand Down
Loading