Skip to content

automation-pipelines.mdx

Latest commit

 

History

History
104 lines (75 loc) · 3.72 KB

automation-pipelines.mdx

File metadata and controls

104 lines (75 loc) · 3.72 KB
title Automation Pipelines Map
sidebarTitle Automation Pipelines
description This document tracks automation systems and where they write data.
keywords
livepeer
automation pipelines
internal
map
automation
systems
write
data

Automation Surfaces

  • GitHub Actions workflows in .github/workflows/
  • Workflow helper scripts in .github/scripts/
  • n8n pipeline assets in snippets/automations/scripts/n8n/
  • Maintenance scripts in tools/scripts/

See generated workflow inventory: workflows-index.mdx.

Core Pipelines

1) Quality + CI

  • test-suite.yml - changed-file checks + browser test
  • test-v2-pages.yml - v2 browser sweep + artifacts/comments
  • broken-links.yml - advisory link checker
  • openapi-reference-validation.yml - blocking OpenAPI endpoint-reference integrity checks for v2 + locales with conservative autofix on non-PR runs

OpenAPI workflow behavior:

  • Triggers: PR (main, docs-v2), push (main, docs-v2), daily schedule (04:35 UTC), manual dispatch
  • Validator: tests/integration/openapi-reference-audit.js
  • Autofix scope: method case, METHOD /path spacing, leading slash only
  • Failure handling: unresolved findings update a single rolling marker issue (<!-- openapi-reference-audit -->); clean runs close it with a resolution comment
  • Labels ensured idempotently before issue sync: docs-v2, help wanted, status: needs-triage, type: bug, area: ci-cd
  • Local reproduction:
    • node tests/integration/openapi-reference-audit.js --full --strict --report /tmp/openapi-audit.md --report-json /tmp/openapi-audit.json
    • node tests/integration/openapi-reference-audit.js --full --fix --write --report /tmp/openapi-audit-fix.md --report-json /tmp/openapi-audit-fix.json

Triage for endpoint-not-found-in-spec:

  1. identify mapped spec from report
  2. verify endpoint exists in mapped spec
  3. update frontmatter + component reference together
  4. retire removed endpoints from docs routes/locales when needed

2) Data Refresh Pipelines

  • update-livepeer-release.yml -> updates globals release data
  • update-forum-data.yml -> updates forum data snippets
  • update-ghost-blog-data.yml -> updates ghost blog data snippets
  • update-youtube-data.yml -> updates YouTube data snippets
  • project-showcase-sync.yml -> updates showcase pipeline data

3) Governance + Intake Pipelines

  • discord-issue-intake.yml + issue-auto-label.yml
  • review automation workflows (build-review-assets.yml, generate-review-table.yml, update-review-template.yml)

Showcase + Trending Topics Pipeline Notes

Showcase

Primary artifacts:

  • snippets/automations/showcase/showcaseData.jsx
  • workflow and n8n assets for showcase sync

Operational intent:

  • searchable/sortable ecosystem entries
  • pipeline reusable for additional curation sources

Trending Topics / Aggregation

Primary artifacts:

  • snippets/automations/forum/forumData.jsx
  • snippets/automations/blog/ghostBlogData.jsx
  • snippets/automations/youtube/youtubeData.jsx

Operational intent:

  • aggregate recent community signal across forum/blog/YouTube
  • feed “latest” sections and maintain freshness automatically

Operational Controls

  • Generated catalogs for scripts/workflows/templates prevent blind spots.
  • CI and pre-commit checks reduce drift between pipeline outputs and docs expectations.
  • Where GitHub Actions and n8n overlap, both are retained for maintainer flexibility.

Related