Skip to content

Take control over your live stream video by running it yourself. Streaming + chat out of the box.

chore(ci): update CI to run more less often and more efficient

Gabe Kangasf3a96a06ffb5
diff --git a/.github/workflows/automated-end-to-end-api.yaml b/.github/workflows/automated-end-to-end-api.yaml
index 09c6a9499a..8b3f665aea 100644
--- a/.github/workflows/automated-end-to-end-api.yaml
+++ b/.github/workflows/automated-end-to-end-api.yaml
@@ -1,3 +1,13 @@
+# This workflow runs automated API integration tests using Earthly
+# Triggers:
+# - Push/PR with Go file changes
+# Skips:
+# - Web-only changes
+# Uses:
+# - Earthly for reproducible builds
+# - QEMU for cross-platform testing
+# - Retries up to 3 times for flaky tests
+
name: Automated API tests
on:
diff --git a/.github/workflows/browser-testing.yml b/.github/workflows/browser-testing.yml
index 29a5877a1d..17bd3fd1b0 100644
--- a/.github/workflows/browser-testing.yml
+++ b/.github/workflows/browser-testing.yml
@@ -1,3 +1,10 @@
+# This workflow runs browser-based tests using Cypress
+# Triggers:
+# - Push/PR with web or browser test changes
+# Skips:
+# - Documentation-only changes in web/
+# - Configuration-only changes
+
name: Browser Tests
on:
@@ -30,11 +37,27 @@ jobs:
uses: actions/checkout@v5
if: github.event_name == 'push'
+ - name: Get changed files
+ id: changed-files-yaml
+ uses: tj-actions/changed-files@v46
+ with:
+ files_yaml: |
+ testable:
+ - 'web/**/*.{tsx,ts,jsx,js,css,scss}'
+ - 'test/automated/browser/**'
+ - '**/*.go'
+ - 'go.mod'
+ - 'go.sum'
+ docs:
+ - '**/*.md'
+
- uses: actions/setup-node@v4
+ if: steps.changed-files-yaml.outputs.testable_any_changed == 'true'
with:
node-version: '22.18.0'
- name: Cache node modules
+ if: steps.changed-files-yaml.outputs.testable_any_changed == 'true'
uses: actions/cache@v4
env:
cache-name: cache-node-modules-browser-tests
@@ -47,14 +70,17 @@ jobs:
${{ runner.os }}-
- uses: actions/setup-go@v5
+ if: steps.changed-files-yaml.outputs.testable_any_changed == 'true'
with:
go-version: '1.24'
cache: true
- name: Install Google Chrome
+ if: steps.changed-files-yaml.outputs.testable_any_changed == 'true'
run: sudo apt-get update && sudo apt-get install google-chrome-stable
- name: Run Browser tests
+ if: steps.changed-files-yaml.outputs.testable_any_changed == 'true'
uses: nick-fields/retry@v3
with:
timeout_minutes: 20
diff --git a/.github/workflows/build-storybook.yml b/.github/workflows/build-storybook.yml
index 2bc02b8a89..c1dfc86c73 100644
--- a/.github/workflows/build-storybook.yml
+++ b/.github/workflows/build-storybook.yml
@@ -1,3 +1,15 @@
+# This workflow builds and deploys Storybook component documentation
+# Triggers:
+# - Push to develop branch with changes to:
+# - web/stories/** (story files)
+# - web/components/** (component source)
+# - web/.storybook/** (Storybook config)
+# - web/i18n/** (translations)
+# Output:
+# - Generates updated story files
+# - Builds Storybook to docs/components
+# - Dispatches event to owncast.github.io for deployment
+
name: Build and Deploy Components+Style Guide
on:
push:
@@ -16,6 +28,13 @@ jobs:
if: github.repository == 'owncast/owncast'
steps:
+ - id: skip_check
+ uses: fkirc/skip-duplicate-actions@v5
+ with:
+ concurrent_skipping: 'same_content_newer'
+ cancel_others: 'true'
+ skip_after_successful_duplicate: 'true'
+
- name: Check out pull request code
uses: actions/checkout@v5
if: github.event_name == 'pull_request'
diff --git a/.github/workflows/chromatic.yml b/.github/workflows/chromatic.yml
index baaabfc625..9104b38e2c 100644
--- a/.github/workflows/chromatic.yml
+++ b/.github/workflows/chromatic.yml
@@ -1,6 +1,16 @@
# .github/workflows/chromatic.yml
-# Workflow name
+# This workflow publishes Storybook to Chromatic for visual regression testing
+# Triggers:
+# - Push/PR with changes to web/ directory
+# Skips:
+# - Static files
+# - next.config.js changes
+# - Renovate bot PRs
+# Features:
+# - Uses onlyChanged for efficient testing
+# - Publishes visual diffs for review
+
name: 'Chromatic'
on:
diff --git a/.github/workflows/container.yaml b/.github/workflows/container.yaml
index 396028a61f..9232a7eefc 100644
--- a/.github/workflows/container.yaml
+++ b/.github/workflows/container.yaml
@@ -1,6 +1,14 @@
# See https://docs.earthly.dev/ci-integration/vendor-specific-guides/gh-actions-integration
# for details.
+# This workflow builds the development container image
+# Triggers:
+# - Nightly scheduled builds (2 AM UTC)
+# - Push/PR to develop with relevant file changes
+# Skips:
+# - Documentation-only changes
+# - Web-only changes (web/** without Go changes)
+
name: Build development container
on:
@@ -9,9 +17,25 @@ on:
push:
branches:
- develop
+ paths:
+ - '**/*.go'
+ - 'go.mod'
+ - 'go.sum'
+ - 'Dockerfile'
+ - 'Earthfile'
+ - 'build/**'
+ - '.github/workflows/container.yaml'
pull_request:
branches:
- develop
+ paths:
+ - '**/*.go'
+ - 'go.mod'
+ - 'go.sum'
+ - 'Dockerfile'
+ - 'Earthfile'
+ - 'build/**'
+ - '.github/workflows/container.yaml'
jobs:
Earthly:
diff --git a/.github/workflows/css-lint.yaml b/.github/workflows/css-lint.yaml
index 5282e8c2a7..7f22c84b19 100644
--- a/.github/workflows/css-lint.yaml
+++ b/.github/workflows/css-lint.yaml
@@ -1,3 +1,11 @@
+# This workflow checks CSS/SCSS code quality and formatting
+# Triggers:
+# - Push/PR with changes to web/ directory
+# Checks:
+# - Prettier formatting for CSS/SCSS files
+# - Stylelint rules for code quality
+# Note: Only runs when CSS or SCSS files are changed
+
name: CSS Lint and Formatting
on:
diff --git a/.github/workflows/go-lint.yml b/.github/workflows/go-lint.yml
index 5c90deccd1..d2a70ebae5 100644
--- a/.github/workflows/go-lint.yml
+++ b/.github/workflows/go-lint.yml
@@ -1,3 +1,11 @@
+# This workflow runs golangci-lint to check Go code quality
+# Triggers:
+# - Push/PR with Go file changes
+# Skips:
+# - Web-only changes
+# - Dependabot PRs (separate workflow)
+# Note: Only reports on new issues to reduce noise
+
name: Lint
on:
push:
diff --git a/.github/workflows/go-tests.yaml b/.github/workflows/go-tests.yaml
index eb3ade6ac8..8e8cb65763 100644
--- a/.github/workflows/go-tests.yaml
+++ b/.github/workflows/go-tests.yaml
@@ -1,3 +1,11 @@
+# This workflow runs Go unit tests across multiple OS and Go versions
+# Triggers:
+# - Push/PR with Go file changes (*.go, go.mod, go.sum)
+# - Skips when only web/ directory changes
+# Test Matrix:
+# - PRs: Latest Go on Ubuntu only (fast feedback)
+# - Develop/Main: Full matrix (ensure cross-platform compatibility)
+
name: Go Tests
on:
@@ -12,8 +20,8 @@ jobs:
test:
strategy:
matrix:
- go-version: [1.23.x, 1.24.x]
- os: [ubuntu-latest, macos-latest, windows-latest, ubuntu-24.04-arm]
+ go-version: ${{ github.event_name == 'pull_request' && fromJSON('["1.24.x"]') || fromJSON('["1.23.x", "1.24.x"]') }}
+ os: ${{ github.event_name == 'pull_request' && fromJSON('["ubuntu-latest"]') || fromJSON('["ubuntu-latest", "macos-latest", "windows-latest", "ubuntu-24.04-arm"]') }}
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v5
@@ -48,6 +56,8 @@ jobs:
run: go test ./...
test-bsds:
+ # Only run BSD tests on push events (not PRs) for efficiency
+ if: github.event_name == 'push'
runs-on: macos-latest
strategy:
matrix:
diff --git a/.github/workflows/hls-tests.yml b/.github/workflows/hls-tests.yml
index 7880199479..f3bea925cc 100644
--- a/.github/workflows/hls-tests.yml
+++ b/.github/workflows/hls-tests.yml
@@ -1,3 +1,13 @@
+# This workflow tests HLS video streaming functionality
+# Triggers:
+# - Push/PR with Go file changes
+# Skips:
+# - Web-only changes
+# Tests:
+# - Local storage backend
+# - S3 storage backend (when secrets available)
+# - Retries up to 3 times for flaky network tests
+
name: HLS tests
on:
diff --git a/.github/workflows/javascript-format-test-build.yml b/.github/workflows/javascript-format-test-build.yml
index dbbf0d4725..d072b81ed7 100644
--- a/.github/workflows/javascript-format-test-build.yml
+++ b/.github/workflows/javascript-format-test-build.yml
@@ -1,6 +1,16 @@
+# This workflow handles Javascript formatting, linting, testing, and building
+# Triggers:
+# - Push/PR with changes to web/ directory
+# Skips:
+# - Markdown files
+# Jobs:
+# 1. formatting: ESLint and Prettier formatting
+# 2. unused-code: Knip checks for unused code and dependencies
+# 3. web-bundle: Builds and bundles the web app (only on develop branch)
+# Note: Auto-fixes and commits formatting issues on push events
+
name: Javascript
-# This action works with pull requests and pushes
on:
push:
paths:
diff --git a/.github/workflows/shellcheck.yml b/.github/workflows/shellcheck.yml
index d976e5b426..ffb252f626 100644
--- a/.github/workflows/shellcheck.yml
+++ b/.github/workflows/shellcheck.yml
@@ -1,3 +1,11 @@
+# This workflow checks shell scripts for common issues using shellcheck
+# Triggers:
+# - Push/PR to develop with changes to .sh files
+# Checks:
+# - All shell scripts recursively
+# - Reports info-level severity and above
+# - Follows sourced files with -x flag
+
name: Lint
on:
@@ -20,6 +28,13 @@ jobs:
container:
image: docker.io/ubuntu:24.04
steps:
+ - id: skip_check
+ uses: fkirc/skip-duplicate-actions@v5
+ with:
+ concurrent_skipping: 'same_content_newer'
+ cancel_others: 'true'
+ skip_after_successful_duplicate: 'true'
+
- name: Check out pull request code
uses: actions/checkout@v5
if: github.event_name == 'pull_request'
diff --git a/.github/workflows/translations.yml b/.github/workflows/translations.yml
index 786545ceba..7b1390558c 100644
--- a/.github/workflows/translations.yml
+++ b/.github/workflows/translations.yml
@@ -1,3 +1,14 @@
+# This workflow manages internationalization (i18n) with Crowdin
+# Triggers:
+# - Hourly schedule to sync translations
+# - Push with changes to translation files or config
+# Process:
+# 1. Extracts translatable strings from source code
+# 2. Uploads source strings to Crowdin
+# 3. Downloads translated strings from Crowdin
+# 4. Creates PR with updated translations
+# Note: Uses concurrency control to prevent overlapping runs
+
name: Translation job
on: