create-release-buildkite-plugin/plugin.yml at main · OctopusDeploy/create-release-buildkite-plugin · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
name: Octopus Deploy Create Release
description: Buildkite Plugin to create a release in Octopus Deploy
author: https://github.com/OctopusDeploy
requirements:
  - octopus
configuration:
  properties:
    api_key:
      type: string
      description: 'The Octopus API key itself, not the name of a variable holding it (changed in 0.2.0). Prefer the octopus-login plugin, which stores no secret.'
    channel:
      type: string
      description: 'The name or ID of the channel to use for the new release. If omitted, the best channel will be selected.'
    debug:
      type: boolean
      default: false
      description: 'Enable debug logging.'
    default_package_version:
      type: string
      description: 'Use the default version number of all packages for this release.'
    git_ref:
      type: string
      description: 'Git branch reference to the specific resources of a version controlled Octopus Project. Only valid for version controlled projects.'
    git_commit:
      type: string
      description: 'Git commit pointing to the specific resources of a version controlled Octopus Project. If empty, it will use the HEAD from the corresponding git_ref parameter.'
    ignore_channel_rules:
      type: boolean
      default: false
      description: 'Create the release ignoring any version rules specified by the channel.'
    ignore_existing:
      type: boolean
      default: false
      description: 'Ignore existing releases if present in Octopus Deploy with the matching version number.'
    output_format:
      enum:
        - basic
        - json
        - table
      description: 'The output format of the octopus CLI; one of "basic", "json", or "table".'
    packages:
      type: [string, array]
      description: 'A single version number or a 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.'
    project:
      type: string
      description: 'The name or ID of the project associated with this release.'
    release_notes:
      type: string
      description: 'The release notes associated with the new release (Markdown is supported).'
    release_notes_file:
      type: string
      description: 'Path to a file that contains release notes for the new release. Supports Markdown files.'
    release_number:
      type: string
      description: 'The number for the new release.'
    server:
      type: string
      description: 'The base URL hosting Octopus Deploy (i.e. "https://octopus.example.app"). Not needed when using the octopus-login plugin.'
    space:
      type: string
      description: 'The name or ID of a space within which this command will be executed. If omitted, the default space will be used.'
  required:
    - project
  additionalProperties: false