-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Optimizing GH actions, to use less minutes.
We can use `.lagoon.yml` to set up a GH deployment,
that we can use to listen for in GH actions.
This is an alternative to us spending a lot of GH minutes
just waiting for the site to become available.
By using bash traps, we can also send back error codes
when `drush deploy` (or other stuff) goes wrong.
This means we have to remove the `set -e`, but we
get around that by calling exit in the catcher.
Ontop of that, also setting up `concurrency` rules to
`ci-tests`, so if a second push is made, we cancel the
old and unrelated workflow.
With this set up, a new GH Action can be created, if you
need a link to the environment:
```
on:
deployment_status
jobs:
tests:
if: github.event.deployment_status.state == 'success'
runs-on: ubuntu-latest
steps:
- run: echo "$URL"
env:
URL: ${{ github.event.deployment_status.target_url }}
```- Loading branch information
Showing
4 changed files
with
78 additions
and
82 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,5 @@ | ||
| on: | ||
| pull_request: | ||
| # We have two groups of jobs in this workflow that reacts on actions: | ||
| # | ||
| # 1. We update the status of a Github Deployment on: | ||
| # - opened | ||
| # - synchronize | ||
| # - reopened | ||
| # - closed | ||
| # | ||
| # 2. We forward all events to lagoon via InformLagoon | ||
| types: [ opened, synchronize, reopened, closed, edited ] | ||
| name: Lagoon integration | ||
|
|
||
|
|
@@ -31,62 +22,6 @@ jobs: | |
| /^.{1,100}$/ | ||
| errorMessage: 'Branch name too long. This cannot be deployed to Lagoon.' | ||
|
|
||
| CheckEnvironment: | ||
| name: Check environment | ||
| runs-on: ubuntu-latest | ||
| if: ${{ github.event.action == 'opened' || github.event.action == 'reopened' || github.event.action == 'synchronize' }} | ||
| needs: [BranchNameLength] | ||
| permissions: | ||
| # Give the default GITHUB_TOKEN permission to create and update deployments | ||
| deployments: write | ||
| steps: | ||
| - name: Generate environment data | ||
| id: environment | ||
| run: | | ||
| echo ::set-output name=id::pr-${{github.event.number}} | ||
| echo ::set-output name=url::'https://varnish.pr-${{github.event.number}}.${{ env.LAGOON_PROJECT }}.${{ env.LAGOON_HOST }}/' | ||
| echo ::set-output name=logs::'https://ui.lagoon.${{ env.LAGOON_HOST }}/projects/${{ env.LAGOON_PROJECT }}/${{ env.LAGOON_PROJECT }}-pr-${{github.event.number}}/deployments' | ||
| - name: Start deployment | ||
| uses: bobheadxi/[email protected] | ||
| id: deployment | ||
| with: | ||
| step: start | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| env: ${{ steps.environment.outputs.id }} | ||
| ref: ${{ github.head_ref }} | ||
| logs: ${{ steps.environment.outputs.logs }} | ||
| debug: ${{ runner.debug && 'true' || 'false' }} | ||
| - name: Generate wait-on config | ||
| # Retrieval of Let's Encrypt certificate sometimes fail in Lagoon. | ||
| # In this case a self-signed certificate will be used. Allow this. | ||
| run: | | ||
| echo "{\"strictSSL\": false}" > $RUNNER_TEMP/wait-on.config.json | ||
| - name: Wait for environment to become available | ||
| uses: iFaxity/[email protected] | ||
| with: | ||
| resource: ${{ steps.environment.outputs.url }} | ||
| # Time in ms. Wait for 20 mins for deployment to complete. We have | ||
| # seen deployments taking up to 17 mins. | ||
| timeout: 1200000 | ||
| # Poll every 10 seconds. For whatever reason Lagoon environments may | ||
| # return 200 during the deployment process even though the deployment | ||
| # is not complete. Reduce polling interval to the risk of this | ||
| # happening. | ||
| interval: 10000 | ||
| config: ${{ runner.temp }}/wait-on.config.json | ||
| - name: Finish deployment | ||
| if: always() | ||
| uses: bobheadxi/[email protected] | ||
| with: | ||
| step: finish | ||
| token: ${{ secrets.GITHUB_TOKEN }} | ||
| status: ${{ job.status }} | ||
| deployment_id: ${{ steps.deployment.outputs.deployment_id }} | ||
| env: ${{ steps.deployment.outputs.env }} | ||
| env_url: ${{ steps.environment.outputs.url }} | ||
| logs: ${{ steps.environment.outputs.logs }} | ||
| debug: ${{ runner.debug && 'true' || 'false' }} | ||
|
|
||
| CloseEnvironment: | ||
| name: Close environment | ||
| runs-on: ubuntu-latest | ||
|
|
@@ -112,19 +47,14 @@ jobs: | |
| # legitimate contributions. | ||
| # The integration is controlled by creating synthetic events related to select | ||
| # pull-request events, and send them to Lagoon. | ||
| # | ||
| # The job expects the following secrets: | ||
| # LAGOON_WEBHOOK_URL: The url events are to be delivered to | ||
| # LAGOON_WEBHOOK_SECRET: Shared lagoon webhook secret | ||
| # | ||
| InformLagoon: | ||
| name: Send synthetic event to Lagoon | ||
| runs-on: ubuntu-latest | ||
| needs: [BranchNameLength] | ||
| steps: | ||
| - name: Send pull request event | ||
| uses: distributhor/workflow-webhook@v3 | ||
| env: | ||
| webhook_url: ${{ secrets.LAGOON_WEBHOOK_URL }} | ||
| webhook_secret: ${{ secrets.LAGOON_WEBHOOK_SECRET }} | ||
| webhook_type: 'json-extended' | ||
| - name: Send pull request event | ||
| uses: distributhor/workflow-webhook@v3 | ||
| env: | ||
| webhook_url: ${{ secrets.LAGOON_WEBHOOK_URL }} | ||
| webhook_secret: ${{ secrets.LAGOON_WEBHOOK_SECRET }} | ||
| webhook_type: 'json-extended' | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| #!/bin/bash | ||
|
|
||
| error_handler() { | ||
| DEPLOYMENT_STATUS="failure" | ||
| GH_DEPLOYMENT_ID=$(cat /tmp/gh_deployment_id) | ||
| echo "Setting GH deployment status '$GH_DEPLOYMENT_ID': '$DEPLOYMENT_STATUS'" | ||
|
|
||
| curl -L \ | ||
| -X POST \ | ||
| -H "Authorization: Bearer $GH_DEPLOYMENT_TOKEN" \ | ||
| https://api.github.com/repos/danskernesdigitalebibliotek/dpl-cms/deployments/"$GH_DEPLOYMENT_ID"/statuses \ | ||
| -d "{\"environment\":\"$LAGOON_PR_HEAD_BRANCH\",\"state\":\"$DEPLOYMENT_STATUS\"}" | ||
|
|
||
| exit "$1" | ||
| } | ||
|
|
||
| # Set up trap for ERR signal | ||
| trap 'error_handler $?' ERR |