# Setup a CI workflow

# GitHub Actions

To set up a GitHub Actions CI workflow for a project, first, create a ci.yml file inside the .github/workflows folder at the root of the solution's workspace:

.github/workflows/ci.yml
workspace
├── .github
├──── workflows
├────── ci.yml
├── package.json

Then, open the newly created file and copy/paste the following content:

.github/workflows/ci.yml
name: CI

# PNPM setup based on https://github.com/pnpm/action-setup#use-cache-to-reduce-installation-time

on:
  push:
    branches: ["main"]
  pull_request:
    branches: ["main"]

env:
  CI: true

concurrency:
  group: ci-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Install pnpm
        uses: pnpm/action-setup@v4
        with:
          run_install: false

      - name: Install Node.js
        uses: actions/setup-node@v4
        with:
            node-version: ">=22.0.0"
            check-latest: true
            cache: pnpm
            cache-dependency-path: pnpm-lock.yaml

      - name: Install dependencies
        run: pnpm install --frozen-lockfile

      - name: Lint
        run: pnpm lint

      - name: Build
        run: pnpm build

      - name: Test
        run: pnpm test

Finally, defines the specific validation steps for the workflow and add a branch rule protecting your main branch.

# Azure Pipelines

To set up an Azure Pipelines CI workflow for a project, first, create a template file named setup.yml. Then, create a ci.yml file that includes this template and defines the specific validation steps for the workflow.

# setup.yml

To setup a template file, create setup.yml file inside the .pipelines/templates folder at the root of the solution's workspace

.pipelines/templates/setup.yml
workspace
├── .pipelines
├──── templates
├────── setup.yml
├── package.json

Then, open the newly created file and copy/paste the following content:

.pipelines/templates/setup.yml
steps:
  - task: UseNode@1
    displayName: Use Node.js 22
    inputs:
      version: 22
      checkLatest: true

  - task: Cache@2
    inputs:
      key: 'pnpm | "$(Agent.OS)" | pnpm-lock.yaml'
      path: $(Pipeline.Workspace)/.pnpm-store
    displayName: Cache pnpm

  - script: |
      npm install -g pnpm@latest-9
      pnpm config set store-dir $(Pipeline.Workspace)/.pnpm-store
    displayName: Setup pnpm

  - script: pnpm install --frozen-lockfile
    displayName: pnpm install

Update the PNPM version to match the one used in your repository.

# ci.yml

Then, create a ci.yml file inside the .pipelines folder at the root of the solution's workspace:

.pipelines/ci.yml
trigger: none

steps:
- template: templates/setup.yml

- script: pnpm lint
  displayName: pnpm lint

- script: pnpm build
  displayName: pnpm build

- script: pnpm test
  displayName: pnpm test

Finally, edit the sections of the ci.yml file, setup the pipeline in Azure DevOps and ensure the pipeline as a required build validation for your main branch.