Architektura
Komunita
Legal
Plany
Changelog
Ciel: minimalny pocet krokov po update hlavnej appky.
Navrhnuty workflow (minimal steps)
- Changelog sa drzi v hlavnom app repozitari (
patrikbartas/cvrn). - Tento docs repozitar ma workflow
Sync CVRN Changelog. - Workflow pravidelne stahuje changelog a prepise docs stranku
/docs/changelog/cvrn-app-changelog.
Vysledok: docs changelog je automaticky aktualizovany bez manualneho kopirovania.
Jednorazove nastavenie
- V
docs-cvrnGitHub repo pridaj secret:CVRN_SYNC_TOKEN(PAT s read pristupom dopatrikbartas/cvrna write dodocs-cvrn).
- Volitelne nastav repository variables:
CVRN_CHANGELOG_PATH(defaultdocs/CHANGELOG.md)CVRN_CHANGELOG_REF(defaultmain)
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_dispatcheventcvrn-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.