Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fastly/compute-actions
GitHub Actions for building on Fastly Compute.
https://github.com/fastly/compute-actions
actions fastly-oss-tier1 plugin serverless
Last synced: 1 day ago
JSON representation
GitHub Actions for building on Fastly Compute.
- Host: GitHub
- URL: https://github.com/fastly/compute-actions
- Owner: fastly
- License: mit
- Created: 2020-11-03T12:47:40.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-21T12:46:17.000Z (about 1 month ago)
- Last Synced: 2024-12-18T06:06:38.115Z (8 days ago)
- Topics: actions, fastly-oss-tier1, plugin, serverless
- Language: JavaScript
- Homepage: https://www.fastly.com/blog/introducing-github-actions-for-compute-edge-a-new-resource-to-help-ship-code
- Size: 2.58 MB
- Stars: 41
- Watchers: 20
- Forks: 10
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# GitHub Actions for Compute
This repository contains GitHub Actions to help you build on Fastly's Compute platform, such as installing the CLI, and building and deploying services.
## Usage
To compile and deploy a Compute 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](https://github.com/marketplace/actions/rust-toolchain) action can handle this for you with the following configuration:
```yml
name: Deploy Application
on:
push:
branches: [main]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
targets: wasm32-wasi # WebAssembly target
- name: Deploy to Compute
uses: fastly/compute-actions@v10
env:
FASTLY_API_TOKEN: ${{ secrets.FASTLY_API_TOKEN }}
```
### npm-based Workflow (JavaScript)
GitHub Action runners come with a node toolchain pre-installed, so you can just run `npm install` to fetch your project's dependencies.
```yml
name: Deploy Application
on:
push:
branches: [main]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install project dependencies
run: npm install
- name: Deploy to Compute
uses: fastly/compute-actions@v10
env:
FASTLY_API_TOKEN: ${{ secrets.FASTLY_API_TOKEN }}
```
### go-based Workflow (Go)
Since you need to pick Go version equal to 1.21 or later to build your Go project with GOARCH=wasm and GOOS=wasip1 target, it is recommended to use `actions/setup-go` with the following configuration, so that you can switch to any version of Go you need;
```yml
name: Deploy Application
on:
push:
branches: [main]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Go toolchain
uses: actions/setup-go@v5
with:
go-version: "1.23"
- name: Deploy to the Compute platform
uses: fastly/compute-actions@v5
env:
FASTLY_API_TOKEN: ${{ secrets.FASTLY_API_TOKEN }}
```
### Custom Workflows
Alternatively, you can manually run the individual GitHub Actions for Compute if you want finer control over your workflow:
- [fastly/compute-actions/setup](setup/index.js) - Download the Fastly CLI if not already installed
- [fastly/compute-actions/build](build/index.js) - Build a Compute project. Equivalent to `fastly compute build`
- [fastly/compute-actions/deploy](deploy/index.js) - Deploy a Compute project. Equivalent to `fastly compute deploy`
- [fastly/compute-actions/preview](preview/action.yml) - Deploy a Compute project to a new Fastly Service, which is deleted when the pull-request is merged or closed.
#### Deploy to Fastly when push to `main`
```yml
name: Deploy Application
on:
push:
branches: [main]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Fastly CLI
uses: fastly/compute-actions/setup@v10
with:
cli_version: '1.0.0' # optional, defaults to 'latest'
token: ${{ secrets.GITHUB_TOKEN }}
- name: Install Dependencies
run: npm install
- name: Build Compute Package
uses: fastly/compute-actions/build@v10
with:
verbose: true # optionally enables verbose output, defaults to false
- name: Deploy Compute Package
uses: fastly/compute-actions/deploy@v10
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 }}
```
#### Preview on Fastly for each pull-request
```yml
name: Fastly Compute Branch Previews
concurrency:
group: ${{ github.head_ref || github.run_id }}-${{ github.workflow}}
on:
pull_request:
types: [opened, synchronize, reopened, closed]
jobs:
deploy:
runs-on: ubuntu-latest
defaults:
run:
shell: bash
steps:
- uses: actions/checkout@v4
- uses: fastly/compute-actions/preview@v10
with:
fastly-api-token: ${{ secrets.FASTLY_API_KEY }}
github-token: ${{ secrets.GITHUB_TOKEN }}
```
### Inputs
The following inputs can be used as `with` keys for the actions in this repository; none of them are required:
- `project_directory` - Directory of the project to deploy, relative to the repository root.
- `cli_version` - The version of the Fastly CLI to install, e.g. v0.20.0
- `service_id` - The Fastly service ID to deploy to. Defaults to the value in `fastly.toml`. (deploy only)
- `comment` - An optional comment to be included with the deployed service version. (deploy only)
- `version` - Version to clone from when deploying. Can be "latest", "active", or the number of a specific version. (deploy only)
- `verbose` - Set to true to enable verbose logging.
- `token` - The GitHub token to use when interacting with the GitHub API.
## Security issues
Please see our [SECURITY.md](SECURITY.md) for guidance on reporting security-related issues.
## License
The source and documentation for this project are released under the [MIT License](LICENSE).