Deploy-to-Skynet Github Action
After working with Skynet deployments for some time, you'll want to automate your deploy pipeline. Skynet Labs has Github Action you can easily incorporate into your workflow to automate uploading builds to Skynet.
When added as a step in a workflow, the Deploy to Skynet action will upload a specified directory to Skynet, and, if given a seed, will also create a resolver skylink that points to the upload and will not change after subsequent deploys.
The guide below walks through the steps, but for a full walkthrough, be sure to see Karol's article on Automated deployments on Skynet.
If you're already familiar with Github Actions, add an action to a workflow by adding a step like the following:
- name: Deploy to Skynet
uses: SkynetLabs/deploy-to-skynet-[email protected]
with:
upload-dir: public
github-token: ${{ secrets.GITHUB_TOKEN }}
registry-seed: ${{ secrets.REGISTRY_SEED || '' }}
registry-datakey: ${{ secrets.REGISTRY_DATAKEY || '' }}
Required Directory to upload (usually
build, dist, out or public).This action requires the upload directory to be already available so you will need to run the build step before running this action.
Required Your github token that is required to authenticate posting a comment on pull request.
Default value:
index.htmlDefine a list of space-separated files that the portal should try to serve in if uri points to a directory, ie
index.html /index.html.Define a path to a file that will replace the default 404 Not Found error page, ie
404.html.Use a Github Secret for this seed! DO NOT COMMIT THIS IN PLAIN TEXT.
You can provide a seed (keep it secret, keep it safe) and this action will set the corresponding skynet registry entry value to the deployed resolver skylink.
Public link to the registry entry will be printed in the action log.
Default value:
skylink.txtYou can define custom datakey for a registry entry when used with
registry-seed. Change only if you want to use a specific key, default value will work in all other cases.Default value:
https://siasky.netYou can override default Skynet portal url with any compatible community portal or self-hosted one.
USE GITHUB SECRET - DO NOT COMMIT THIS IN PLAIN TEXT
Portal account private API key used for associating uploads with a specific account. Also used to allow uploads larger than 1GB or access account-only portals. Creating an API key.
(Deprecated. Use
skynet-api-key instead.)USE GITHUB SECRET - DO NOT COMMIT THIS IN PLAIN TEXT
Portal account JWT used for associating uploads with a specific account. Also used to allow uploads larger than 1GB or access account-only portals. Obtaining your JWT.
The resulting skylink.
Example:
sia://IAC6CkhNYuWZqMVr1gob1B6tPg4MrBGRzTaDvAIAeu9A9wThe resulting skylink url (base32 encoded skylink in subdomain).
Example:
https://400bk2i89lheb6d8olltc2grqgfaqfge1im134ed6q1ro0g0fbnk1to.siasky.netA resolver skylink pointing at the resulting skylink. Resolver skylink will remain the same throughout the deploys, but will always resolve to the latest deploy.
Example:
sia://AQDwh1jnoZas9LaLHC_D4-2yP9XYDdZzNtz62H4Dww1jDAThe resulting resolver skylink url (base32 encoded skylink in subdomain). Resolver skylink will remain the same throughout the deploys, but will always resolve to the latest deploy.
Example:
https://040f11qosugpdb7kmq5hobu3sfmr4fulr06tcspmrjtdgvg3oc6m630.siasky.net/Be sure to use a specific version of the action. Version 2 introduced resolver skylinks, replacing the
skyns usage from earlier versions.The Github Action makes use of saving Encrypted Secrets on Github's servers. Avoid re-using seed phrases across contexts or repositories.
This file is a good place to start. In your project, create a
.github/workflows/deploy-to-skynet.ymlfile.name: Deploy to Skynet
on:
push:
branches: [main]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
- uses: actions/setup-[email protected]
with:
node-version: 16.x
- run: yarn
- run: yarn build
- name: "Deploy to Skynet"
uses: SkynetLabs/deploy-to-skynet-[email protected]
with:
upload-dir: build
github-token: ${{ secrets.GITHUB_TOKEN }}
registry-seed: ${{ secrets.SKYNET_REGISTRY_SEED || '' }}
In this walkthrough demo, setting up the Github action starts at 18:50.