isabella232 / compute-actions

GitHub Actions for building on Compute@Edge.

GitHub Actions for Compute@Edge

This repository contains GitHub Actions to help you build on Fastly's Compute@Edge platform, such as installing the CLI, and building and deploying services.

IMPORTANT: Compute@Edge is currently in limited availability. For more information on what this means, read the Fastly product and feature lifecycle guide.

Usage

To compile and deploy a Compute@Edge service at the root of the repository, you can use the fastly/compute-actions main action. This will install the Fastly CLI, build your project, and deploy it to your Fastly service. If you used fastly compute init to initialise your project, this will work out of the box:

Cargo-based Workflow (Rust)

You will need to install the correct Rust toolchain for the action to build your project. The rust-toolchain action can handle this for you with the following configuration:

name: Deploy Application
on:
  push:
    branches: [master]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - name: Install Rust toolchain
      uses: actions-rs/toolchain@v1
      with:
          toolchain: 1.54.0 # current Rust toolchain for Compute@Edge
          target: wasm32-wasi # WebAssembly target

    - name: Deploy to Compute@Edge
      uses: fastly/compute-actions@main
      env:
        FASTLY_API_TOKEN: ${{ secrets.FASTLY_API_TOKEN }}

npm-based Workflow (JavaScript + AssemblyScript)

GitHub Action runners come with a node toolchain pre-installed, so you can just run npm install to fetch your project's dependencies.

name: Deploy Application
on:
  push:
    branches: [master]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2

    - name: Install project dependencies
      run: npm install

    - name: Deploy to Compute@Edge
      uses: fastly/compute-actions@main
      env:
        FASTLY_API_TOKEN: ${{ secrets.FASTLY_API_TOKEN }}

Custom Workflows

Alternatively, you can manually run the individual GitHub Actions for Compute@Edge if you want finer control over your workflow:

• fastly/compute-actions/setup - Download the Fastly CLI if not already installed
• fastly/compute-actions/build - Build a Compute@Edge project. Equivalent to fastly compute build
• fastly/compute-actions/deploy - Deploy a Compute@Edge project. Equivalent to fastly compute deploy

name: Deploy Application
on:
  push:
    branches: [master]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v1

    - name: Set up Fastly CLI
      uses: fastly/compute-actions/setup@main
      with:
        cli_version: '0.36.0' # optional, defaults to 'latest'

    - name: Install Dependencies
      run: npm install

    - name: Build Compute@Edge Package
      uses: fastly/compute-actions/build@main
      with:
        verbose: true # optionally enables verbose output, defaults to false
        skip_verification: true # optional, defaults to false

    - name: Deploy Compute@Edge Package
      uses: fastly/compute-actions/deploy@main
      with:
        service_id: '4tYGx...' # optional, defaults to value in fastly.toml
        comment: 'Deployed via GitHub Actions' # optional
      env:
        FASTLY_API_TOKEN: ${{ secrets.FASTLY_API_TOKEN }}

Security issues

Please see our SECURITY.md for guidance on reporting security-related issues.

License

The source and documentation for this project are released under the MIT License.