CVRN logoCVRN Docs
DocsArchitekturaPlanyChangelog
Sections
  • Zaklady
  • Architektura
  • Komunita
  • Legal
  • Plany
  • Changelog
Zaklady
  • O dokumentacii
  • Ako citat dokumentaciu
  • Struktura repozitara
Architektura
  • Ako aplikacia funguje
  • Diagramy
Komunita
  • Prehlad komunitnych pravidiel
  • CVRN desatoro
  • Onboarding a aktivacia clena
  • Prevadzkove pravidla (draft)
  • Treningovy mod (navrh)
  • WhiteBikes poznamky
  • Analyza Rekola
  • Analyza Slovnaft BAjk
Legal
  • Zasady ochrany osobnych udajov (navrh)
  • GDPR brief pre pravnika
  • RoPA template
  • Reklamacny a incidencny poriadok (draft)
Plany
  • Prehlad planov
  • Stavovy guard model
  • Nahlasene nepozicatelne biky
  • Email notifikacie (outbox)
  • Dynamicky kod a historia
  • Mapa a stanovista
  • Statistiky a historia jazd
  • Logo hover header
  • Backlog whitebikes inspired
Changelog
  • Sync a automatizacia
  • CVRN App Changelog

Sync a automatizacia

PreviousNext

Ako je changelog docs repozitara synchronizovany s hlavnym CVRN app repozitarom.

status: active
type: guide
#changelog
#automation
#sync

Ciel: minimalny pocet krokov po update hlavnej appky.

Navrhnuty workflow (minimal steps)

  1. Changelog sa drzi v hlavnom app repozitari (patrikbartas/cvrn).
  2. Tento docs repozitar ma workflow Sync CVRN Changelog.
  3. Workflow pravidelne stahuje changelog a prepise docs stranku /docs/changelog/cvrn-app-changelog.

Vysledok: docs changelog je automaticky aktualizovany bez manualneho kopirovania.

Jednorazove nastavenie

  1. V docs-cvrn GitHub repo pridaj secret:
    • CVRN_SYNC_TOKEN (PAT s read pristupom do patrikbartas/cvrn a write do docs-cvrn).
  2. Volitelne nastav repository variables:
    • CVRN_CHANGELOG_PATH (default docs/CHANGELOG.md)
    • CVRN_CHANGELOG_REF (default main)

Workflow je v:

  • .github/workflows/sync-cvrn-changelog.yml

Sync script je v:

  • scripts/sync-cvrn-changelog.mjs

Trigger moznosti

Workflow bezi:

  • kazdych 30 minut (schedule),
  • manualne cez workflow_dispatch,
  • cez repository_dispatch event cvrn-release.

Zero-step varianta po release appky

Najlepsie je doplnit do hlavneho app repozitara (cvrn) action, ktora po update changelogu odpali repository_dispatch na docs-cvrn.

Vtedy je sync prakticky okamzity a bez manualnych krokov.

Priklad workflow v app repozitari (cvrn)

name: Trigger Docs Changelog Sync

on:
  push:
    branches: [main]
    paths:
      - docs/CHANGELOG.md

jobs:
  dispatch:
    runs-on: ubuntu-latest
    steps:
      - name: Trigger docs repo sync
        env:
          GH_TOKEN: ${{ secrets.DOCS_REPO_DISPATCH_TOKEN }}
        run: |
          curl -sS -X POST \
            -H "Accept: application/vnd.github+json" \
            -H "Authorization: Bearer $GH_TOKEN" \
            https://api.github.com/repos/patrikbartas/docs-cvrn/dispatches \
            -d '{"event_type":"cvrn-release"}'

Poznamka: DOCS_REPO_DISPATCH_TOKEN musi mat pravo zapisovat do docs-cvrn.

Backlog whitebikes inspiredCVRN App Changelog

On This Page

Navrhnuty workflow (minimal steps)Jednorazove nastavenieTrigger moznostiZero-step varianta po release appkyPriklad workflow v app repozitari (cvrn)
© CVRN dokumentacia