A GitHub Action recommended
Add this file as .github/workflows/release-video.yml. Each time you publish a release, the videos get attached to it.
name: Release video
on:
release:
types: [published]
permissions:
contents: write
jobs:
video:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: 99proteam/shipreel@v1
with:
template: minimal
Copy workflow
B CLI (Node.js 20+)
Run it on your machine, no install needed:
# one-time: download the headless browser
npx playwright install chromium
# render from your changelog
npx shipreel --changelog CHANGELOG.md -o videos
# or from a GitHub release
npx shipreel --release v2.4.0 --repo owner/name
# preview scenes in the browser
npx shipreel preview
Copy commands
Or add it to your project: npm i -D shipreel, then "video": "shipreel" in package.json scripts.
Make it yours: shipreel.config.json
{
"template": "bold",
"brandColor": "#ff5a1f",
"logo": "./assets/logo.svg",
"font": "Archivo",
"sizes": ["landscape", "square", "vertical"],
"cta": "npm i my-lib@latest",
"music": "./assets/music.mp3"
}
Full reference, custom templates and library API: README on GitHub .