release-coda-pack

Simple GitHub Action to release a pack.

How to setup

Generate and copy a Coda API token

Create and copy your Coda API token from your account settings.

Add GitHub secret

Add it as a secret to your repo with the name CODA_API_TOKEN. (could be anything, but this is the default name used by the action)

I recommend you to generate a new token for your project, so you can easily revoke it if needed. Of course, you can also use your already existing personal token.

Here's how to add a secret to your repo using the GitHub CLI:

gh secret set CODA_API_TOKEN

See the GitHub documentation regarding secrets: Creating encrypted secrets for a repository

Add the action to your workflow

Add the action to your workflow file, for example .github/workflows/release-pack.yml

You'll find a template repo with a working example here: coda-workflows/release-pack.yml at main · siriusnottin/coda-workflows · GitHub

You'll need to pass the following parameters to the action:

• codaApiToken: The Coda API token you generated and added as a secret to your repo.
• packPath(optional): The path to the pack file. Defaults to pack.ts.
• packVersion(optional): The version of the pack. If not provided, coda will use the latest uploaded version.
• notes: Release notes for the pack.

Create a pull request to merge your changes into the main branch

It depends on the workflow you've adopted, but here's a simple usage:

• Create a new branch from main (or master)
• Make your changes in the new branch
• Commit and push your changes to the new branch
• Merge your changes into main by creating a pull request

Usage

When the pull request is merged into main, the action will be triggered and will release the pack to Coda.

Action Details

Inputs

Name	Description	Required	Default
codaApiToken	The Coda API token you generated and added as a secret to your repo.	true
packPath	The path to the pack file.	false	pack.ts
packVersion	The version of the pack. If not provided, coda will use the latest uploaded version.	false
notes	Release notes for the pack.	true

Outputs

Name	Description
packReleaseVersion	The released version of the pack.

Examples

Basic

name: Release Coda Pack

on:
  pull_request:
    branches:
      - main

jobs:
  release-coda-pack:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: siriusnottin/upload-coda-pack@v1
        with:
          codaApiToken: ${{ secrets.CODA_API_TOKEN }}
      - uses: siriusnottin/release-coda-pack@v1
        with:
          codaApiToken: ${{ secrets.CODA_API_TOKEN }}
          notes: ${{ github.event.pull_request.title }}

Advanced

name: Release Coda Pack

on:
  pull_request:
    branches:
      - main

jobs:
  release-coda-pack:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: siriusnottin/upload-coda-pack@v1
        with:
          codaApiToken: ${{ secrets.CODA_API_TOKEN }}
      - uses: siriusnottin/release-coda-pack@v1
        with:
          codaApiToken: ${{ secrets.CODA_API_TOKEN }}
          packPath: pack.ts
          packVersion: ${{ steps.upload-coda-pack.outputs.packVersion }}
          notes: ${{ github.event.pull_request.title }}

Useful Links

Coda Packs • Coda API docs

GitHub Actions Documentation

Contribute

Feel free to contribute by opening an issue or submitting a pull request.

License

MIT License. See the LICENSE file for more information.