Pipelines

Azure Pipeline Templates

Usage

To use the templates your azure-pipelines.yml must import this repo like:

resources:
  repositories:
    - repository: templates
      type: github
      name: dirigeants/pipelines
      endpoint: dirigeants # This is likely your github username or organization name

Note: You will have to allow your pipeline to use your github credentials to be used to fetch templates from other repos.

You can do this by going to your Project Settings (in Azure DevOps):

Pipelines

Service Connections

(Your username/organization name should be listed, otherwise the endpoint will be whatever is listed)

Policies

Check: Allow all pipelines to use this endpoint

Save Changes

Lint Template

This template will install the specified version of Node.js, install dependencies, and run the test:lint script defined in your package.json (meaning you can use any linter or any combination of tools).

jobs:
  - template: lint.yml@templates
    # Optional if you want to use all defaults
    parameters:
      # Optional: The version of Node.js you want to use,
      # valid values are ['8.x', '9.x', '10.x', '11.x', ...]
      versionSpec: '10.x'

Docs Template

This is a build and commit to github template, so it can be used for more than just documentation, however it's general usecase is for documentation builds.

Your build must be configured to output files to the /dist folder of your repo. Additionally you must have two secret environmental variables set in your project. As a convience you can create these under your libraries so that you can link them to other pipelines in your project. These variables are ghToken, a github token with the public_repo permission from your account; and commitEmail, the email address to use as the user who is commiting the changes. Please ensure you do use the "secret variable" setting, otherwise these values will be leaked in the logs.

jobs:
  - template: docs.yml@templates
    parameters:
      # Required: The repo to commit to such as 'dirigeants/pipelines`
      ghRef: ''
      # Optional: The name of the branch to commit the build to
      targetBranch: 'gh-pages'
      # Optional: Will only commit the build for master branch if this is set to 'true'
      masterOnly: 'false'
      # Optional: Will sync the whole /dist folder to the branch. If false, will rename /dist/docs.json to /out/branchName.json
      sync: 'true'
      # Optional: The name of the job, and is also used in the commit message
      type: 'Documentation'
      # Optional: The name of the npm script to build your project
      command: 'docs'
      # Optional: A list of other jobs that must be successful before this one runs
      dependsOn: ''
      # Optional: The version of Node.js you want to use,
      # valid values are ['8.x', '9.x', '10.x', '11.x', ...]
      versionSpec: '10.x'