## Description By changing the workflow trigger and the way to check for correct labels, we are trying to allow the PR integrations tests to run every time the PR is updated. That means, if you push changes, and the PR already has ok-to-test label, it will rerun the tests based on new changes ## Automation /ok-to-test tags="@tag.Sanity" ### 🔍 Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/10296910575> > Commit: c59583ba28c8cdff35a12422b8c73838c6efdc85 > <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=10296910575&attempt=1" target="_blank">Cypress dashboard</a>. > Tags: `@tag.Sanity` > Spec: > <hr>Thu, 08 Aug 2024 06:32:48 UTC <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced a new job, `checkTestLabel`, to verify the presence of the "ok-to-test" label on pull requests. - Added a new job, `mark-stale`, to mark the Cypress status as stale when the label is absent. - **Improvements** - Updated the `parse-tags` job to run only after the `checkTestLabel` job, enhancing workflow control. - Modified the conditions for executing the `parse-tags` job based on the output of the `checkTestLabel` job. - **Style** - Minor formatting adjustments for job dependencies in the workflow. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
135 lines
4.9 KiB
YAML
135 lines
4.9 KiB
YAML
name: PR Automation test suite
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
on:
|
|
pull_request:
|
|
branches:
|
|
- release
|
|
- pg
|
|
types: [ labeled, synchronize ]
|
|
|
|
jobs:
|
|
checkTestLabel:
|
|
runs-on: ubuntu-latest
|
|
outputs:
|
|
ok_to_test: ${{ steps.checkLabel.outputs.ok_to_test }}
|
|
steps:
|
|
|
|
- name: Check PR Label
|
|
id: checkLabel
|
|
uses: actions/github-script@v7
|
|
with:
|
|
# This script will check if the PR has ok-to-test label.
|
|
# To avoid being dependent on the event which triggered this workflow,
|
|
# we will always get the pull request labels directly from the context
|
|
# It will later set the output to be "true" or "false".
|
|
script: |
|
|
const labels = context.payload.pull_request.labels.map(label => label.name);
|
|
if (labels.includes("ok-to-test")) {
|
|
console.log("Label 'ok-to-test' is present");
|
|
core.setOutput("ok_to_test", "true");
|
|
} else {
|
|
console.log("Label 'ok-to-test' is not present");
|
|
core.setOutput("ok_to_test", "false");
|
|
}
|
|
|
|
mark-stale:
|
|
needs: [ checkTestLabel ]
|
|
if: needs.checkTestLabel.outputs.ok_to_test == 'false'
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
pull-requests: write
|
|
defaults:
|
|
run:
|
|
shell: bash
|
|
steps:
|
|
- name: Checkout code
|
|
uses: actions/checkout@v4
|
|
# In case of a no label present, mark the Cypress status to be stale
|
|
- name: Mark the Cypress response to be stale
|
|
uses: actions/github-script@v7
|
|
env:
|
|
NODE_PATH: "${{ github.workspace }}/.github/workflows/scripts"
|
|
BODY: |
|
|
Tests have not run on the HEAD ${{ github.event.pull_request.head.sha }} yet
|
|
with:
|
|
script: |
|
|
require("write-cypress-status.js")({core, context, github}, "warning", process.env.BODY)
|
|
|
|
parse-tags:
|
|
needs: [ checkTestLabel ]
|
|
if: needs.checkTestLabel.outputs.ok_to_test == 'true'
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
pull-requests: write
|
|
defaults:
|
|
run:
|
|
shell: bash
|
|
outputs:
|
|
tags: ${{ steps.parseTags.outputs.tags }}
|
|
spec: ${{ steps.parseTags.outputs.spec }}
|
|
matrix: ${{ steps.checkAll.outputs.matrix }}
|
|
steps:
|
|
|
|
# Checkout the code in the current branch in case the workflow is called because of a branch push event
|
|
- name: Checkout the head commit of the branch
|
|
uses: actions/checkout@v4
|
|
with:
|
|
repository: appsmithorg/appsmith
|
|
|
|
# Reads the PR description to retrieve the /ok-to-test or, if that's absent, the /test command
|
|
- name: Read tags from PR description
|
|
uses: actions/github-script@v7
|
|
id: parseTags
|
|
env:
|
|
NODE_PATH: "${{ github.workspace }}/.github/workflows/scripts"
|
|
with:
|
|
script: |
|
|
require("test-tag-parser.js")({core, context, github})
|
|
|
|
# In case of a run with all test cases, allocate a larger matrix
|
|
- name: Check if @tag.All is present in tags
|
|
id: checkAll
|
|
run: |
|
|
if [[ -n "${{ steps.parseTags.outputs.spec }}" ]]; then
|
|
echo "matrix=[0]" >> $GITHUB_OUTPUT
|
|
else
|
|
tags="${{ steps.parseTags.outputs.tags }}"
|
|
if [[ $tags == "@tag.All" ]]; then
|
|
echo "matrix=[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59]" >> $GITHUB_OUTPUT
|
|
else
|
|
echo "matrix=[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19]" >> $GITHUB_OUTPUT
|
|
fi
|
|
fi
|
|
|
|
# In case of a runnable command, update the PR with run details
|
|
- name: Add test response with link to workflow run
|
|
uses: actions/github-script@v7
|
|
env:
|
|
NODE_PATH: "${{ github.workspace }}/.github/workflows/scripts"
|
|
BODY: |
|
|
Your tests are running.
|
|
Tests running at: <${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}>
|
|
Commit: ${{ github.event.pull_request.head.sha }}
|
|
Workflow: `${{ github.workflow }}`
|
|
Tags: `${{ steps.parseTags.outputs.tags }}`
|
|
Spec: `${{ steps.parseTags.outputs.spec }}`
|
|
with:
|
|
script: |
|
|
require("write-cypress-status.js")({core, context, github}, "important", process.env.BODY)
|
|
|
|
# Call the workflow to run Cypress tests
|
|
perform-test:
|
|
needs: [ parse-tags ]
|
|
if: success()
|
|
uses: ./.github/workflows/pr-cypress.yml
|
|
secrets: inherit
|
|
with:
|
|
tags: ${{ needs.parse-tags.outputs.tags}}
|
|
spec: ${{ needs.parse-tags.outputs.spec}}
|
|
matrix: ${{ needs.parse-tags.outputs.matrix}}
|
|
is-pg-build: ${{ github.event.pull_request.base.ref == 'pg' }}
|