GitHub Action
Paperspace Deploy
v1.4
Latest version
A GitHub action for deploying updates to a Paperspace deployment.
| Input | Type | Required? | Description |
|---|---|---|---|
projectId |
string |
Yes | The ID of the project the deployment lives under |
apiKey |
string |
No | Your Paperspace API key. This may also be set using the PAPERSPACE_API_KEY environment variable. |
configPath |
string |
No | The relative file path of the configuration file. |
image |
string |
No | Container image to be used in the configuration |
uses: paperspace/[email protected]
env:
PAPERSPACE_API_KEY: ${{ secrets.PAPERSPACE_API_KEY }}
with:
projectId: p28rlnvnw51You can also pass the api key as an input.
uses: paperspace/[email protected]
with:
apiKey: ${{ secrets.PAPERSPACE_API_KEY }}
projectId: p28rlnvnw51Mark the image as replacable using :image within your .paperspace/app.yaml.
enabled: true
name: Demo
image: :image
port: 8888
resources:
replicas: 1
instanceType: P4000uses: paperspace/[email protected]
env:
PAPERSPACE_API_KEY: ${{ secrets.PAPERSPACE_API_KEY }}
with:
image: paperspace/deployment-fixture:${{ steps.docker-tag-name.outputs.DOCKER_TAG_NAME }})
projectId: p28rlnvnw51name: test-pr
on:
pull_request:
paths:
- "*"
jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: paperspace/[email protected]
name: Deploy Staging
id: deploy
env:
PAPERSPACE_API_KEY: ${{ secrets.PAPERSPACE_API_KEY }}
with:
projectId: p28rlnvnw51
image: nginx:latestAn example of building a custom image and syncing the deployment to Paperspace after pushing to a container registry.
name: fixture-release
on:
push:
tags:
- deployment-fixture@*
jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set docker tag name
run: echo "::set-output name=DOCKER_TAG_NAME::$(echo $GITHUB_REF | cut -d / -f 3 | sed 's/deployment-fixture@//')"
id: docker-tag-name
- name: Set up docker build
uses: docker/setup-buildx-action@v1
- name: Login to DockerHub
uses: docker/login-action@v1
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Build and push
uses: docker/build-push-action@v2
with:
file: Dockerfile
push: true
tags: |
paperspace/deployment-fixture:${{ steps.docker-tag-name.outputs.DOCKER_TAG_NAME }}
- uses: paperspace/[email protected]
name: Deploy to Paperspace
id: deploy
env:
PAPERSPACE_API_KEY: ${{ secrets.PAPERSPACE_API_KEY }}
with:
projectId: ptzm6ujwqwa
image: paperspace/deployment-fixture:${{ steps.docker-tag-name.outputs.DOCKER_TAG_NAME }}
You may supply an optional relative path to a Paperspace config as follows:
- uses: paperspace/[email protected]
name: Deploy action
id: deploy
env:
PAPERSPACE_API_KEY: ${{ secrets.PAPERSPACE_API_KEY }}
with:
projectId: p28rlnvnw51
configPath: ./random/paperspace.jsonc
image: paperspace/deployment-fixtureBy default, the action looks for a config file in order of precedence:
paperspace.yamlpaperspace.ymlpaperspace.jsonpaperspace.jsoncpaperspace.toml.paperspace/app.yaml.paperspace/app.yml.paperspace/app.json.paperspace/app.jsonc.paperspace/app.toml
.json, .jsonc, .toml, .yaml, .yml are all supported.
Deployments allow for versioned deployment specs. Example:
enabled: true,
name: Demo
apiVersion: v0alpha1
...These versions are not required. If a version is not supplied in the deployment config file used by this GitHub Action, latest will be used implicitly.