GitHub Actions
You can use Shipyard's GitHub Action to run actions/jobs on Shipyard-deployed ephemeral environments, authenticating into them via a bypass token. The action connects with Shipyard during a workflow, fetching necessary environment variables in order to run E2E tests where authentication via OAuth is normally required.
How to use
In your GitHub workflow file, usually located in .github/workflows/, you can use the Shipyard's GitHub Action as per the following example:
on: [pull_request]
jobs:
cypress-e2e-tests:
runs-on: ubuntu-latest
name: Collect the bypass token and URL for an authenticated ephemeral environment attached to this PR in order to run E2E tests on it.
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Integrate Shipyard
uses: shipyard/shipyard-action@1.0.0
env:
SHIPYARD_API_TOKEN: ${{ secrets.SHIPYARD_API_TOKEN }}
- name: Run the E2E tests against the ephemeral environment
run: npm run test
shell: bash
env:
CYPRESS_BASE_URL: $SHIPYARD_ENVIRONMENT_URL
CYPRESS_BYPASS_TOKEN: $SHIPYARD_BYPASS_TOKEN
The GitHub Action can be configured by passing inputs or environment variables:
Get your token
To access your Organization Settings page, click on Settings at the top of your main dashboard:
If you have the Shipyard API enabled for your organization, you can grab its token by going to the Org Settings page and clicking the copy button:
Inputs
- name: Integrate Shipyard
uses: shipyard/shipyard-action@1.0.0
with:
api-token: ${{ secrets.SHIPYARD_API_TOKEN }}
timeout-minutes: 30
| Input name | Description | Default Value |
|---|---|---|
| api-token | Token required to connect to Shipyard's APIs. Can be obtained from your Org Settings page | - |
| timeout-minutes | Number of minutes to wait for Shipyard environment before timing out | 60 |
| app-name | Filter the environments by name of the application on the Shipyard app | - |
Environment Variables
- name: Integrate Shipyard
uses: shipyard/shipyard-action@1.0.0
env:
SHIPYARD_API_TOKEN: ${{ secrets.SHIPYARD_API_TOKEN }}
SHIPYARD_TIMEOUT: 30
| Environment Variable | Description | Default Value |
|---|---|---|
| SHIPYARD_API_TOKEN | Token required to connect to Shipyard's APIs. Can be obtained from your Org Settings page | - |
| SHIPYARD_TIMEOUT | Number of minutes to wait for Shipyard environment before timing out | 60 |
| SHIPYARD_APP_NAME | Filter the environments by name of the application on the Shipyard ap | 60 |
Inputs are given precedence over environment variables.
If input api-token or environment variable SHIPYARD_API_TOKEN is not provided, error is raised.
On successful run, the following environment variables are set, which can then be passed onto other actions in the same workflow.
| Parameter Name | Description |
|---|---|
| SHIPYARD_ENVIRONMENT_ID | ID of the ephemeral environment |
| SHIPYARD_ENVIRONMENT_URL | URL of the ephemeral environment |
| SHIPYARD_BYPASS_TOKEN | Token to bypass authentication |