{"id":11143,"date":"2024-08-06T20:44:00","date_gmt":"2024-08-07T01:44:00","guid":{"rendered":"https:\/\/www.rushworth.us\/lisa\/?p=11143"},"modified":"2024-09-06T10:52:37","modified_gmt":"2024-09-06T15:52:37","slug":"using-templates-in-azure-build-pipelines","status":"publish","type":"post","link":"https:\/\/www.rushworth.us\/lisa\/?p=11143","title":{"rendered":"Using Templates in Azure Build Pipelines"},"content":{"rendered":"\n

I inherited a Java application that is actually five<\/em> applications — and the build pipeline had a lot<\/em> of repetition. Tell maven to use this<\/em> POM file, now use that<\/em> one, and now the other<\/em> one. It wasn’t great, but it got even more cumbersome when I needed to split the production and development builds to use a different pool (network rule: prod and dev servers may not communicate … so the dev agent talks to the dev image repo which is used by the dev deployment. The prod agent talks to the prod<\/em> image repo which is used by the prod deployment). Instead of having five “hey, maven, do this build” blocks, I now have ten<\/em>.<\/p>\n\n\n\n

So I created a template for the build step — jdk-path and maven-path are pipeline variables. The rest is the Maven build task with parameters to supply the step display name, pom file to use, and environment flag. <\/p>\n\n\n\n

Maven Build Template:<\/strong><\/p>\n\n\n

\n# maven-build-step.yml\nparameters:\n  - name: pomFile\n    type: string\n  - name: dockerEnv\n    type: string\n  - name: displayName\n    type: string\n\nsteps:\n  - task: Maven@3\n    displayName: '${{ parameters.displayName }}'\n    inputs:\n      mavenPomFile: '${{ parameters.pomFile }}'\n      mavenOptions: '-Xmx3072m'\n      javaHomeOption: 'Path'\n      jdkDirectory: $(jdk-path)\n      mavenVersionOption: 'Path'\n      mavenDirectory: $(maven-path)\n      mavenSetM2Home: true\n      jdkArchitectureOption: 'x64'\n      publishJUnitResults: true\n      testResultsFiles: '**\/surefire-reports\/TEST-*.xml'\n      goals: 'package -Denv=${{ parameters.dockerEnv }} jib:build'\n<\/pre><\/div>\n\n\n
Then my build pipeline uses the template and supplies a few parameters<\/p>\n\n\n\n
Pipeline:<\/strong><\/p>\n\n\n
\n# azure-pipelines.yml\ntrigger: none\n\nvariables:\n  appName: 'NPM'\n\nstages:\n  - stage: Build\n    jobs:\n      - job: NonProdBuild\n        condition: ne(variables['Build.SourceBranchName'], 'production')\n        displayName: 'Build non-production branch'\n        variables:\n          DockerFlag: 'docker_dev'\n        pool:\n          name: 'Engineering NPM'\n        steps:\n          - template: maven-build-template.yml\n            parameters:\n              pomFile: 'JAVA\/KafkaStreamsApp\/npm\/pom.xml'\n              dockerEnv: $(DockerFlag)\n              displayName: 'Building Kafka Streams App'\n\n          - template: maven-build-template.yml\n            parameters:\n              pomFile: 'JAVA\/DataSync\/npmInfo\/pom.xml'\n              dockerEnv: $(DockerFlag)\n              displayName: 'Building Data Sync App'\n\n          - template: maven-build-template.yml\n            parameters:\n              pomFile: 'JAVA\/GroupingRules\/pom.xml'\n              dockerEnv: $(DockerFlag)\n              displayName: 'Building Grouping Rules App'\n\n          - template: maven-build-template.yml\n            parameters:\n              pomFile: 'JAVA\/Errorhandler\/pom.xml'\n              dockerEnv: $(DockerFlag)\n              displayName: 'Building Error Handler App'\n\n          - template: maven-build-template.yml\n            parameters:\n              pomFile: 'JAVA\/Events\/pom.xml'\n              dockerEnv: $(DockerFlag)\n              displayName: 'Building Events App'\n\n      - job: ProdBuild\n        condition: eq(variables['Build.SourceBranchName'], 'production')\n        displayName: 'Build production branch'\n        variables:\n          DockerFlag: 'docker_prod'\n        pool:\n          name: 'Engineering NPM Prod'\n        steps:\n          - template: maven-build-template.yml\n            parameters:\n              pomFile: 'JAVA\/KafkaStreamsApp\/npm\/pom.xml'\n              dockerEnv: $(DockerFlag)\n              displayName: 'Building Kafka Streams App'\n\n          - template: maven-build-template.yml\n            parameters:\n              pomFile: 'JAVA\/DataSync\/npmInfo\/pom.xml'\n              dockerEnv: $(DockerFlag)\n              displayName: 'Building Data Sync App'\n\n          - template: maven-build-template.yml\n            parameters:\n              pomFile: 'JAVA\/GroupingRules\/pom.xml'\n              dockerEnv: $(DockerFlag)\n              displayName: 'Building Grouping Rules App'\n\n          - template: maven-build-template.yml\n            parameters:\n              pomFile: 'JAVA\/Errorhandler\/pom.xml'\n              dockerEnv: $(DockerFlag)\n              displayName: 'Building Error Handler App'\n\n          - template: maven-build-template.yml\n            parameters:\n              pomFile: 'JAVA\/Events\/pom.xml'\n              dockerEnv: $(DockerFlag)\n              displayName: 'Building Events App'\n<\/pre><\/div>\n\n\n
I think this could be made more concise … but it will do for now!<\/p>\n","protected":false},"excerpt":{"rendered":"
I inherited a Java application that is actually five applications — and the build pipeline had a lot of repetition. Tell maven to use this POM file, now use that one, and now the other one. It wasn’t great, but it got even more cumbersome when I needed to split the production and development builds …<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1510],"tags":[1091,2047,2048,1092,2045,2046],"class_list":["post-11143","post","type-post","status-publish","format-standard","hentry","category-ado","tag-ado","tag-azure-build-pipeline","tag-azure-build-pipelines","tag-azure-devops","tag-azure-pipeline","tag-azure-pipelines"],"_links":{"self":[{"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/posts\/11143","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=11143"}],"version-history":[{"count":1,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/posts\/11143\/revisions"}],"predecessor-version":[{"id":11144,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/posts\/11143\/revisions\/11144"}],"wp:attachment":[{"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=11143"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=11143"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=11143"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}