GitHub Action for Scaleway

This action enables you to interact with Scaleway services via the scw v2 command-line client.

Usage

1. Configure the action with the 4 required environments variables
2. Pass the command to execute using scw
3. Every step invoking this action writes the stdout to ${GITHUB_WORKSPACE}/scw.output. You can then use this file in later steps. Please note that subsequent calls to this action will overwrite this file, so you might want to copy it to another file if you'll still need it later.

Here's an example which starts a DEV1-S instance in the fr-par-1 region:

    - name: Create a new instance
        uses: jawher/[email protected]
        env:
          SCW_ACCESS_KEY: ${{ secrets.SCW_ACCESS_KEY }}
          SCW_SECRET_KEY: ${{ secrets.SCW_SECRET_KEY }}
          SCW_ORGANIZATION_ID: ${{ secrets.SCW_ORGANIZATION_ID }}
          SCW_ZONE: fr-par-1
        with:
          args: instance server create image=ubuntu_bionic type=DEV1-S name=workhorse tags.0=temp tags.1=workhorse --wait -o=json

      - name: Get instance id and expose it in INSTANCE_ID env var
        run: echo ::set-env name=INSTANCE_ID::$(cat "${GITHUB_WORKSPACE}/scw.output" | jq -r '.id')

      - name: Do something with the instance
        run: ...

      - name: Delete instance
        uses: jawher/[email protected]
        env:
          SCW_ACCESS_KEY: ${{ secrets.SCW_ACCESS_KEY }}
          SCW_SECRET_KEY: ${{ secrets.SCW_SECRET_KEY }}
          SCW_ORGANIZATION_ID: ${{ secrets.SCW_ORGANIZATION_ID }}
          SCW_ZONE: fr-par-1
        with:
          args: instance server delete server-id=${{ env.INSTANCE_ID }} with-ip=true force-shutdown=true

Secrets

• SCW_ACCESS_KEY – Required: a Scaleway API token (more info).
• SCW_SECRET_KEY – Required: Scaleway API token (more info).
• SCW_ORGANIZATION_ID – Required: A Scaleway organization id

Environment variables

We provide defaults for the following, these may also be overridden:

• SCW_REGION- Optional: Region to target, one of fr-par or nl-ams. If unset, it will be guessed by the scw CLI from the zone: fr-par-1 -> fr-par, nl-ams-1 -> nl-ams, ...
• SCW_ZONE- Required: Zone to target, one of fr-par-1 or nl-ams-1

Versioning

This action uses the following versioning scheme:

jawher/action-scw@v{M.m.p}-{a}

Where:

• {M.m.p} is the scw CLI version: Major, Minor and patch
• {a} is the action single version number: there may be multiple versions of this action for a single CLI version, e.g. v2.3.1 uses the same scw CLI 2.3.1 as before, but adds support for the newly added region parameter.

License

The Dockerfile and associated scripts and documentation in this project are released under the MIT License.

Credits

This action is heavily inspired from DigitalOcean/action-doctl