Building videos using GitHub actions

For users that want to keep video scripts and assets on GitHub, we support directly building videos using GitHub actions.

Getting your API Key

To use the GitHub action, you will need a Narakeet API key. Send an email to contact@narakeet.com to request your key.

We strongly suggest storing your API key as an encrypted secret

Configuring the GitHub action

Use the action narakeet/build-video-github-action step with the following three parameters:

  • source-path: the path to the main video script file in your repository
  • api-key: your API key.
  • github-token: set to $ (GitHub will automatically assign it)

The action has two outputs:

  • video-file: the resulting video file, ready for uploading to GitHub action artifacts or further processing.
  • video-url: Temporary secure (signed) video URL - valid for 10 minutes - which can be used to download the video.

An example

The following workflow will generate a video and upload it to the workflow artifacts. You can then pass it on to the next action, or download directly from the workflow artifact page.

name: Make videos
on: [push]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: narakeet/build-video-github-action@v1.0.3
      id: video
      with:
        source-path: hello-world/script/script.md
        github-token: $
        api-key: $
    - uses: actions/upload-artifact@v1
      with:
        name: video
        path: "$"

More information