hypercodec / shuttle-deploy

Github Actions repo for deploying to https://shuttle.rs

shuttle-deploy

Github Actions repo for deploying to https://shuttle.rs

Quickstart

name: Deploy

on:
    push:
        branches:
            - main
    workflow_dispatch:

concurrency: production

jobs:
    deploy:
        runs-on: ubuntu-latest
        environment: production
        steps:
            - uses: actions/checkout@v3
            - uses: hypercodec/shuttle-deploy@latest
              with:
                api_key: ${{ secrets.SHUTTLE_API_KEY }}

Parameters

* = required

• api_key* - Your shuttle.rs API key. For security reasons, please use Github Secrets so as to not leak access to your Shuttle account.
• project_name - The name of the Shuttle project.
• path - The path to your Shuttle project.

Common Errors

• 404 not found - This usually means that your Shuttle project does not exist. To solve this issue ensure that you have run cargo shuttle init and cargo shuttle project start to initialize the project on your shuttle console

shuttle-deploy's Issues

Latest-tag not working

Shuttle installation optimization

The current approach utilizes cargo install to install shuttle, but is highly inefficient due to the number of dependencies that cargo has to compile.

Remove node_modules

Not necessary, I don't remember why but I added that back at some point.

Cryptic crash on deployment

The test deployment crashes with this log:

/home/runner/.cargo/bin/cargo shuttle deploy --name cargo-shuttle-test

2023-08-03T18:01:21.427715732+00:00  INFO Entering queued state
2023-08-03T18:01:21.427744857+00:00 TRACE shuttle_deployer::deployment::queue: getting a build slot
2023-08-03T18:01:21.432649700+00:00 TRACE {uri="http://gateway:8001/stats/load"} shuttle_deployer::deployment::gateway_client: calling gateway
2023-08-03T18:01:21.435223940+00:00 DEBUG hyper::client::connect::http: connecting to 10.99.0.14:8001
2023-08-03T18:01:21.438992860+00:00 DEBUG hyper::client::connect::http: connected to 10.99.0.14:8001
2023-08-03T18:01:21.440454825+00:00 DEBUG hyper::client::pool: pooling idle connection for ("http", gateway:8001)
2023-08-03T18:01:21.442801146+00:00 TRACE {response="Response { status: 200, version: HTTP/1.1, headers: {\"content-type\": \"application/json\", \"content-length\": \"38\", \"date\": \"Thu, 03 Aug 2023 18:01:21 GMT\"}, body: Body(Streaming) }"} shuttle_deployer::deployment::gateway_client: Load response

2023-08-03T18:01:21.445389879+00:00  INFO Entering building state

Deployment crashed

Run the following for more details

cargo shuttle logs 4af56a9c-e1a6-4ca4-94d6-466299848019
Error: Error: The process '/home/runner/.cargo/bin/cargo' failed with exit code 1

This does not happen when deploying from my local machine