Skip to content

Latest commit

 

History

History
230 lines (196 loc) · 6.74 KB

lab07.md

File metadata and controls

230 lines (196 loc) · 6.74 KB
Raw

7 - CI/CD

In this lab you will use CI/CD workflows.

Duration: 15-20 minutes

References:

7.1 Update the CI workflow

  1. Open the workflow file ci-workflow.yml
  2. Edit the file and copy the following YAML content to replace the strategy of the ci job:
    strategy:
      # Cancel all matrix jobs if one of them fails
      fail-fast: true
      matrix:
        # our matrix for testing across node versions and OSs
        node-version: [12, 14, 16]
        os: [macos-latest, windows-latest, ubuntu-latest]
  1. In the ci job, before the deploy-test job, copy the following YAML content to use the upload-artifact action:
      - shell: bash
        run: |
          echo 'Test upload artifact' > output.log
      - name: Upload output file
        uses: actions/upload-artifact@v4
        with:
          name: output-log-file
          path: output.log
  1. In the deploy-test job, after the checkout action, copyt the following YAML content to use the download-artifact action
      - name: Download a single artifact
        uses: actions/download-artifact@v4
        with:
          name: output-log-file
  1. Commit the changes into a new feature/lab07 branch
  2. Open a new pull request from Pull requests

Make sure it is your repository pull request to not propose changes to the upstream repository. From the drop-down list choose the base repository to be yours.

  1. Once PR opened, go to Actions and see the details of your running workflow
  2. Once all checks have passed, click on the button Merge pull request to complete the PR
  3. Go to Actions and see the details of your running workflow

7.2 Update the CD workflow

  1. Open the workflow file cd-workflow.yml
  2. Edit the file and copy the following YAML content before the Deploy to production step:
    - name: Download artifact from build job
      uses: actions/download-artifact@v4
      with:
        name: node-app
  1. Update the workflow to run on push events
on:
  push:
     branches: [main]
  1. Commit the changes into the main branch
  2. Go to Actions and see the details of your running workflow

7.3 Final

ci-workflow.yml 
name: 07-1. CI Workflow

# Trigger CI for every PR event, when PR has target branch = main
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  # The first job lints the code base
  lint:
    uses: githubabcs/gh-abcs-actions/.github/workflows/super-linter.yml@main

  # CI job to run a test suite on the code base
  ci:
    name: CI
    # We want to test across mutiple OSs, defined by our matrix
    runs-on: ${{ matrix.os }}
    needs: lint
    strategy:
      # Cancel all matrix jobs if one of them fails
      fail-fast: true
      matrix:
        # our matrix for testing across node versions and OSs
        node-version: [12, 14, 16]
        os: [macos-latest, windows-latest, ubuntu-latest]
    
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      # Configure our node environment according to matrix
      - name: Setup node ${{ matrix.node-version }} on ${{ matrix.os }}
        uses: actions/setup-node@v4
        with:
          node-version: ${{ matrix.node-version }}

      - name: Run test suite
        run: |
          echo npm ci
          echo npm run build --if-present
          echo npm test

      # Add here the upload-artifact action
      - shell: bash
        run: |
          echo 'Test upload artifact' > output.log
      - name: Upload output file
        uses: actions/upload-artifact@v4
        with:
          name: output-log-file
          path: output.log

  # If both linting and CI succeeds we want to deploy the code to a test environment
  deploy-test:
    name: Deploy to test env
    runs-on: ubuntu-latest
    needs: ci
    environment:
      name: TEST
      url: https://test.company.com
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      # Add here the download-artifact step
      - name: Download a single artifact
        uses: actions/download-artifact@v4
        with:
          name: output-log-file

      # Placeholder - this step would be some action or run commands that deploys the code
      - name: Deploy to test env
        if: ${{ success() }}
        run: |
          echo "Deploying to test environment"
cd-workflow.yml 
name: 07-2. CD Workflow 

on:
  push:
     branches: [main]

env:
  AZURE_WEBAPP_NAME: your-app-name    # set this to your application's name
  AZURE_WEBAPP_PACKAGE_PATH: '.'      # set this to the path to your web app project, defaults to the repository root
  NODE_VERSION: '14.x'                # set this to the node version to use

# We only want to allow one deploy-to-prod workflow running at any point in time
concurrency: 
  group: cd-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4

    - name: Set up Node.js
      uses: actions/setup-node@v4
      with:
        node-version: ${{ env.NODE_VERSION }}

    - name: npm install, build, and test
      run: |
        echo npm install
        echo npm run build --if-present
        echo npm run test --if-present

    - name: Upload artifact for deployment job
      uses: actions/upload-artifact@v4
      with:
        name: node-app
        path: .

  deploy:
    name: Deploy
    runs-on: ubuntu-latest
    needs: build

    environment:
      name: PROD
      url: ${{ steps.deploy-to-webapp.outputs.webapp-url }}

    steps:
    
    # Add here the download-artifact step
    - name: Download artifact from build job
      uses: actions/download-artifact@v4
      with:
        name: node-app

    - name: Deploy to Prod
      if: ${{ success() }}
      run: echo "Specific deploy steps..."

    - name: 'Deploy to Azure WebApp'
      id: deploy-to-webapp 
      uses: azure/webapps-deploy@v3
      continue-on-error: true
      with:
        app-name: ${{ env.AZURE_WEBAPP_NAME }}
        publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
        package: ${{ env.AZURE_WEBAPP_PACKAGE_PATH }}