checkly #4
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # .github/checkly.yml | |
| name: "checkly" | |
| on: [deployment_status] | |
| # Set the necessary credentials and export variables we can use to instrument our test run. Use the ENVIRONMENT_URL | |
| # to run your checks against staging, preview or production. | |
| env: | |
| CHECKLY_API_KEY: ${{ secrets.CHECKLY_API_KEY }} | |
| CHECKLY_ACCOUNT_ID: ${{ secrets.CHECKLY_ACCOUNT_ID }} | |
| ENVIRONMENT_URL: ${{ github.event.deployment_status.environment_url }} | |
| CHECKLY_TEST_ENVIRONMENT: ${{ github.event.deployment_status.environment }} | |
| jobs: | |
| test-e2e: | |
| if: github.event.deployment_status.state == 'success' # Only run when the deployment was successful. | |
| name: Test E2E on Checkly | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| ref: "${{ github.event.deployment_status.deployment.ref }}" | |
| fetch-depth: 0 | |
| - name: Set branch name # workaround to detect branch name in "deployment_status" actions | |
| run: echo "CHECKLY_TEST_REPO_BRANCH=$(git show -s --pretty=%D HEAD | tr -s ',' '\n' | sed 's/^ //' | grep -e 'origin/' | head -1 | sed 's/\origin\///g')" >> $GITHUB_ENV | |
| - uses: pnpm/action-setup@v4 | |
| name: Install pnpm | |
| with: | |
| version: 9 | |
| run_install: false | |
| - name: Install Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20 | |
| cache: "pnpm" | |
| - name: Restore or cache node_modules | |
| id: cache-node-modules | |
| uses: actions/cache@v3 | |
| with: | |
| path: node_modules | |
| key: node-modules-${{ hashFiles('pnpm-lock.yaml') }} | |
| - name: Install dependencies | |
| if: steps.cache-node-modules.outputs.cache-hit != 'true' | |
| run: pnpm ci | |
| - name: Run checks # run the checks passing in the ENVIRONMENT_URL and recording a test session. | |
| id: run-checks | |
| run: npx checkly test -e ENVIRONMENT_URL=${{ env.ENVIRONMENT_URL }} --reporter=github --record | |
| - name: Create summary # export the markdown report to the job summary. | |
| id: create-summary | |
| run: cat checkly-github-report.md > $GITHUB_STEP_SUMMARY | |
| - name: Deploy checks # if the test run was successful and we are on Production, deploy the checks | |
| id: deploy-checks | |
| if: steps.run-checks.outcome == 'success' && github.event.deployment_status.environment == 'Production' | |
| run: npx checkly deploy --force |