Create an Angles product video from your repository homepage whenever you publish a GitHub Release.
The Action sends Angles your homepage URL and the published Release: its tag, title and notes. It does not read your repository files. Angles renders the video with its Release Video template: the version, what the release notes say changed, your live homepage, what the product does, and where to get it.
Only the bullet points in the release notes are shown as changes, word for word. Angles never adds a change the notes do not list. If the notes have no list, that scene uses the narration instead.
Create an Angles API key with concepts:write, videos:read, and videos:render, then add it to your repository as the ANGLES_API_KEY Actions secret.
Add this workflow to .github/workflows/angles-repo-video.yml:
name: Create release video
on:
release:
types: [published]
permissions:
contents: write
jobs:
video:
runs-on: ubuntu-latest
steps:
- uses: anglesvideo/release-video-action@v1
with:
api-key: ${{ secrets.ANGLES_API_KEY }}
github-token: ${{ github.token }}Set the repository's Website field to your product homepage. Or provide a URL explicitly:
- uses: anglesvideo/release-video-action@v1
with:
api-key: ${{ secrets.ANGLES_API_KEY }}
product-url: https://example.comThe Action adds a Product video section to the Release body when rendering completes. The video URL is also available as the video-url output and in the workflow run summary.
The Action needs permission to edit the Release. The workflow above passes GitHub's automatic token and grants contents: write. If you prefer to add it to an existing workflow, use:
permissions:
contents: write
jobs:
video:
runs-on: ubuntu-latest
steps:
- uses: anglesvideo/release-video-action@v1
with:
api-key: ${{ secrets.ANGLES_API_KEY }}
github-token: ${{ github.token }}Set publish-to-release: false for a manual test run or when you only want the workflow summary and output.
| Input | Required | Default | Description |
|---|---|---|---|
api-key |
Yes | — | Angles API key. Pass it from an Actions secret. |
github-token |
When publishing | — | GitHub token for updating the Release body. Pass ${{ github.token }}. |
product-url |
No | Repository homepage | Homepage to use as the video source. |
api-base-url |
No | https://api.angles.video/api/developer/v1 |
Angles Developer API base URL. |
template-id |
No | release_video on a Release, otherwise the first Angles recommendation |
Existing template to use instead. |
aspect-ratio |
No | landscape |
landscape or portrait. |
timeout-seconds |
No | 900 |
Maximum render wait, between 60 and 3600 seconds. |
poll-interval-seconds |
No | 10 |
Status check interval, between 3 and 60 seconds. |
publish-to-release |
No | true |
Add or update the video link in the Release body. |
| Output | Description |
|---|---|
video-url |
Final hosted video URL. |
edit-url |
Angles editor link. |
video-id |
Angles video ID. |
release-url |
Updated GitHub Release URL. |