azure devops setup ci pipeline

Setting up a CI pipeline on Azure DevOps

In this section we will create a Continuous Integration pipeline for compiling project code. This pipeline will be configured to be triggered every time there is a commit to the Azure DevOps repository, regardless of which branch it is made on.

The creation of the pipeline will follow the project workflow, so a new branch named feature/ci-pipeline will be created and the YAML file for the pipeline will be pushed to it.

Then, a Pull Request (PR) will be created in order to merge the new branch into the appropriate branch (provided in -b flag). The PR will be automatically merged if the repository policies are met. If the merge is not possible, either the PR URL will be shown as output, or it will be opened in your web browser if using -w flag.

The script located at /scripts/pipelines/azure-devops/pipeline_generator.sh will automatically create this new branch, create a build pipeline based on a YAML template appropriate for the project programming language or framework, create the Pull Request and, if it is possible, merge this new branch into the specified branch.

Prerequisites

This script will commit and push the corresponding YAML template into your repository, so please be sure your local repository is up-to-date (i.e you have pulled latest changes with git pull).

Creating the pipeline using provided script

Usage

pipeline_generator.sh \
  -c <config file path> \
  -n <{pipeline_type} name> \
  -l <language or framework> \
  -d <project local path> \
  [-t <target-directory>] \
  [-b <branch>] \
  [-w]

Note	The config file for the build pipeline is located at /scripts/pipelines/azure-devops/templates/ci/ci-pipeline.cfg.

Flags

-c, --config-file                    [Required] Configuration file containing {pipeline_type} definition.
-n, --pipeline-name                  [Required] Name that will be set to the {pipeline_type}.
-l, --language or framework          [Required] Language or framework of the project.
--sonar-url <sonarqube url>
--sonar-token <sonarqube token>
-d, --local-directory                [Required] Local directory of your project.
-t, --target-directory                Target directory of build process. Takes precedence over the language/framework default one.
-b, --target-branch                   Name of the branch to which the Pull Request will target. PR is not created if the flag is not provided.
-w                                    Open the Pull Request on the web browser if it cannot be automatically merged. Requires -b flag.

Examples

Quarkus project

Quarkus native project

./pipeline_generator.sh -c ./templates/ci/ci-pipeline.cfg -n quarkus-project-build -l quarkus --sonar-url http://1.2.3.4:9000 --sonar-token 6ce6663b63fc02881c6ea4c7cBa6563b8247a04e -d C:/Users/$USERNAME/Desktop/quarkus-project -b develop {openBrowserFlag}

Quarkus project using JVM

./pipeline_generator.sh -c ./templates/ci/ci-pipeline.cfg -n quarkus-project-build -l quarkus-jvm --sonar-url http://1.2.3.4:9000 --sonar-token 6ce6663b63fc02881c6ea4c7cBa6563b8247a04e -d C:/Users/$USERNAME/Desktop/quarkus-project -b develop {openBrowserFlag}

Node.js project

./pipeline_generator.sh -c ./templates/ci/ci-pipeline.cfg -n node-project-build -l node --sonar-url http://1.2.3.4:9000 --sonar-token 6ce6663b63fc02881c6ea4c7cBa6563b8247a04e -d C:/Users/$USERNAME/Desktop/node-project -b develop {openBrowserFlag}

Angular project

./pipeline_generator.sh -c ./templates/ci/ci-pipeline.cfg -n angular-project-build -l angular --sonar-url http://1.2.3.4:9000 --sonar-token 6ce6663b63fc02881c6ea4c7cBa6563b8247a04e -d C:/Users/$USERNAME/Desktop/angular-project -b develop {openBrowserFlag}