Uploaded image for project: 'Bitbucket Cloud'
  1. Bitbucket Cloud
  2. BCLOUD-21775

Support description for custom pipelines and variables

XMLWordPrintable

    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

      Hello,

      Custom pipeline are a great way to automate our workflow. However if there are too many pipelines, it can be difficult to understand which pipeline to use.

      As a way to improve user-friendliness, I would love to be able to add descriptions to custom pipelines and their variables. This description could be displayed to the users in the run pipeline window, letting them know more about what the pipeline is supposed to do (useful as the name alone cannot carry as much information).

      To update the custom pipeline example from [https://support.atlassian.com/bitbucket-cloud/docs/pipeline-triggers/|https://support.atlassian.com/bitbucket-cloud/docs/pipeline-triggers/|https://support.atlassian.com/bitbucket-cloud/docs/pipeline-triggers/],]
      the bitbucket-pipelines.yml could look like this:

       

      pipelines:
        custom:
          custom-name-and-region: #name of this pipeline
            - description: "this pipeline simply display the username and region in the logs"
            - variables:          #list variable names under here
                - name: Username
                  description: "The name to display"
                - name: Region
                  description: "The region to display"
            - step: 
                script:
                  - echo "User name is $Username"
                  - echo "and they are in $Region" 

       

       

      This pipeline window could be displayed like this.

      https://community.atlassian.com/t5/image/serverpage/image-id/185397iAA7E5FAB9CF6543D/image-size/large?v=v2&px=999

      (sorry the wiki-attachment option is broken, i cannot add the image directly to this ticket)

      For non-manual pipelines, the description could be added in the pipeline run logs to make it easier to understand the logs.

              Unassigned Unassigned
              b7ca950c9b13 Lilian
              Votes:
              2 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: