azure-devops-cli-extension/azure-devops/azext_devops/dev/pipelines/_help.py at 38a86de6bc9360d8ecc038e7284483769e24ad83 · Azure/azure-devops-cli-extension · 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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------

from knack.help_files import helps


def load_pipelines_help():
    helps['pipelines'] = """
    type: group
    short-summary: Manage Azure Pipelines.
    long-summary: This command group is a part of the azure-devops extension.
    """

    helps['pipelines runs'] = """
    type: group
    short-summary: Manage pipeline runs.
    long-summary:
    """

    helps['pipelines runs tag'] = """
    type: group
    short-summary: Manage pipeline run tags.
    long-summary:
    """

    helps['pipelines build'] = """
    type: group
    short-summary: Manage builds.
    long-summary:
    """

    helps['pipelines variable-group'] = """
    type: group
    short-summary: Manage variable groups.
    long-summary:
    """

    helps['pipelines variable-group variable'] = """
    type: group
    short-summary: Manage variables in a variable group.
    long-summary:
    """

    helps['pipelines pool'] = """
    type: group
    short-summary: Manage agent pools.
    long-summary:
    """

    helps['pipelines folder'] = """
    type: group
    short-summary: Manage folders for organizing pipelines.
    long-summary:
    """

    helps['pipelines folder delete'] = """
    type: command
    short-summary: Delete a folder.
    long-summary: This will delete all pipelines in the folder.
    """

    helps['pipelines agent'] = """
    type: group
    short-summary: Manage agents.
    long-summary:
    """

    helps['pipelines queue'] = """
    type: group
    short-summary: Manage agent queues.
    long-summary:
    """

    helps['pipelines variable'] = """
    type: group
    short-summary: Manage pipeline variables.
    long-summary:
    """

    helps['pipelines build tag'] = """
    type: group
    short-summary: Manage build tags.
    long-summary:
    """

    helps['pipelines build definition'] = """
    type: group
    short-summary: Manage build definitions.
    long-summary:
    """

    helps['pipelines release'] = """
    type: group
    short-summary: Manage releases.
    long-summary:
    """

    helps['pipelines release definition'] = """
    type: group
    short-summary: Manage release definitions.
    long-summary:
    """

    helps['pipelines runs artifact'] = """
    type: group
    short-summary: Manage pipeline run artifacts.
    long-summary:
    """

    helps['pipelines runs artifact upload'] = """
    type: command
    short-summary: Upload a pipeline artifact.
    long-summary: >
        Upload a pipeline artifact to a specific run. Optionally specify custom properties as metadata.
    examples:
      - name: Upload a pipeline artifact with custom properties
        text: |
          az pipelines runs artifact upload --artifact-name myArtifact --run-id 123 --path /path/to/artifact --properties "user-key1=value1;user-key2=value2"
"""

    helps['pipelines create'] = """
    type: command
    short-summary: Create a new Azure Pipeline (YAML based).
    long-summary:
    examples:
      - name: Create an Azure Pipeline from local checkout repository context
        text: |
          Repository name/url (--repository), type (--repository-type) and branch name (--branch) will be detected from the local git repository
          az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'

      - name: Create an Azure Pipeline for a repository hosted on Github using clone url
        text: |
           az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'
           --repository https://github.com/SampleOrg/SampleRepo --branch master

      - name: Create an Azure Pipeline for a repository hosted on Github organization SampleOrg, repository name SampleRepo
        text: |
           az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'
           --repository SampleOrg/SampleRepoName --branch master --repository-type github

      - name: Create an Azure Pipeline for a repository hosted in a Azure Repo in the same project
        text: |
          az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'
          --repository SampleRepoName --branch master --repository-type tfsgit

      - name: Create an Azure Pipeline for a repository with the pipeline yaml already checked in into the repository
        text: |
          Service connection required for non Azure Repos can be optionally provided in the command to run it non interatively
          az pipelines create --name 'ContosoBuild' --description 'Pipeline for contoso project'
          --repository https://github.com/SampleOrg/SampleRepo --branch master --yml-path azure-pipelines.yml [--service-connection SERVICE_CONNECTION]
    """