Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 3.02 KB

Test-workflows-automation.md

File metadata and controls

55 lines (39 loc) · 3.02 KB
Raw

Automating test workflows in the PR checks.

Test workflows for actions can be automated in the action repo so that whenever a new PR is raised to master or releases/* branches these workflows evaluate on the branch from which PR is raised.

This process of automated testing enables one to run tests on PRs from a branch in a repo and also PRs from a forked repo. Post reviewing the PR for security vulnerabilities, the author(s) / admin(s) can set a label as safe to run test on the PR which will trigger this workflow automatically. This will ensure that the new PR is not breaking any existing flow. Once the checks are successful and are not breaking any existing scenarios, the PR will be merged subsequently.

Process to automate the workflows:

  1. Create a test.yml workflow in .github/workflows of the action repo.

  2. Put the triggering condition for this workflow as on: pull_request_target if forked repo PR checks need to be checked automatically otherwise on: pull_request should do. Visit pull_request_target for more details.

  3. Steps include:

    1. Checkout the repo.
    2. Install the node_modules using npm install as the PRs raised to master branch will not have node_modules without which the workflow fails.
    3. Build the action using npm run build( Since some action repos don’t have the updated lib/.js files as they recommend to exempt lib/.js in PRs. This step ensures the action to have updated lib files).
    4. Here we are targeting to run a sample test for the action.For multiple scenarios, one can mention different scenarios in the same file and have multiple steps in the WF file calling the necessary actions for the required setup(For example if a .Net app needs to be deployed ,make sure you set up .Net using actions/setup-dotnet@v1 and resolve those dependencies here).
    5. Run the action with uses: ./ which will pick the current branch of the repo to execute the workflow. Specify the input parameters which are required by the action in the with: parameters.

Sample template:

name: 

#triggers on pull_request from both forked repo and this repo on PR type opened/labeled

on:
  pull_request_target:
    types: [labeled, opened]
    branches:
      - master
      - 'releases/*'

jobs:

    deploy:
      # runs this deploy on when the PR is labelled as 'safe to run test'
      if: contains(github.event.pull_request.labels.*.name, 'safe to run test')
      runs-on: windows-latest
      steps:
      - name: Checkout from PR branch  
        uses: actions/checkout@v2

      - name: installing node_modules
        run: npm install --prod
       
      - name: Build GitHub Action
        run: npm run build
          
      # include any workflow/action specific dependencies
      
      - uses: ./                  #picks the current action PR code.
        with:
          #input parameters of the action.