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

Allow more flexible YAML in pipeline scripts

    XMLWordPrintable

    Details

    • Feedback Policy:

      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.

      Description

      In order to keep even relatively simple pipelines configurations DRY, we are required to write scripts referenced by pipelines. What I can do is use YAML anchors to reference an entire pipeline:

      image: node
      pipelines:   custom:     run-tests: &run-tests
            - step:           script:             - npm install
                  - node_modules/.bin/grunt eslint sasslint karma
        default: *run-tests
      

      What I can't do is compose multiple scripts. For example, say I want several things to be custom scripts (so I can trigger them) and also compose them into branch scripts run automatically. Because of the way that YAML anchors and inheritance/merging works, this:

      image: node
      pipelines:   custom:     run-tests:       - step:           script: &run-tests-script
                  - npm install && export NPM_INSTALLED=1
                  - node_modules/.bin/grunt eslint sasslint karma
          deploy-dev:       - step:           script: &deploy-dev-script
                  - "[[ -n $NPM_INSTALLED ]] || npm install"
                  - node_modules/.bin/grunt deploy:dev
          deploy-qa:       - step:           script: &deploy-qa-script
                  - "[[ -n $NPM_INSTALLED ]] || npm install"
                  - node_modules/.bin/grunt deploy:qa
        branches:     master:       - step:           script:             - *run-tests-script
                  - *deploy-dev-script
                  - *deploy-qa-script
      

      Is parsed into this:

      {
        "image": "node",
        "pipelines": {
          "custom": {
            "run-tests": [
              {
                "step": {
                  "script": [
                    "npm install && export NPM_INSTALLED=1",
                    "node_modules/.bin/grunt eslint sasslint karma e2e"
                  ]
                }
              }
            ],
            "deploy-dev": [
              {
                "step": {
                  "script": [
                    "[[ -n $NPM_INSTALLED ]] || npm install",
                    "node_modules/.bin/grunt deploy:dev"
                  ]
                }
              }
            ],
            "deploy-qa": [
              {
                "step": {
                  "script": [
                    "[[ -n $NPM_INSTALLED ]] || npm install",
                    "node_modules/.bin/grunt deploy:qa"
                  ]
                }
              }
            ]
          },
          "default": [
            {
              "step": {
                "script": [
                  [
                    "npm install && export NPM_INSTALLED=1",
                    "node_modules/.bin/grunt eslint sasslint karma e2e"
                  ],
                  [
                    "[[ -n $NPM_INSTALLED ]] || npm install",
                    "node_modules/.bin/grunt deploy:dev"
                  ],
                  [
                    "[[ -n $NPM_INSTALLED ]] || npm install",
                    "node_modules/.bin/grunt deploy:qa"
                  ]
                ]
              }
            }
          ]
        }
      }
      

      The offending piece being the array of arrays of strings in script. By flattening arrays of arrays of strings in script you would allow further customization of pipelines.

      An alternative to this would be to simply allow multiple steps as those can be composed purely in YAML.

        Attachments

          Activity

            People

            Assignee:
            Unassigned
            Reporter:
            colin.kennedy475142178 Colin Kennedy
            Votes:
            3 Vote for this issue
            Watchers:
            4 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: