curvenote / action-deploy

Deploy a Curvenote website to curve.space hosting

Curvenote GitHub Action: Deploy

Description

This GitHub action allows you to automate deploying a website to the curve.space hosting service. In order to deploy a website, the repository must have a curvenote.yml file at the repository root.

Configure your repository using the curvenote command line tool (CLI) - see docs.curvenote.com on how to install the CLI. Once installed the curvenote init command will collect information and create your curvenote.yml file, commit this to the repository and push to GitHub.

Note: also consider adding the _build/ to your .gitignore file, if you are testing your website locally.

Basic Usage

To deploy using github actions, add a new file to your repository at .github/workflows/deploy.yml containing:

name: Curvenote Deploy
on:
  push:
    branches:
      - main
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to curve.space
        uses: curvenote/action-deploy@v1
        env:
          CURVENOTE_TOKEN: ${{ secrets.CURVENOTE_TOKEN }}

This requires your Curvenote API token to be saved in your GitHub secrets under CURVENOTE_TOKEN. See Authorization for how to generate an API token. To add a secret see the GitHub docs.

Options

You can add options for the deployment using the with field in the action step.

steps:
  - uses: actions/curvenote-deploy@v1
    with:
      pull: true

• pull (optional) when set to true the action will attempt to pull the latest versions of any linked projects from curvenote.com.

Support

Open an issue on curvenote/action-deploy and we'll respond. 🚀