mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-05-02 16:20:26 +00:00
1.3 KiB
1.3 KiB
Kontrolní seznam vydání
Tento kontrolní seznam použijte před označením nebo publikováním nové verze OmniRoute.
Verze a seznam změn
- Navýšit verzi
package.json(xyz) ve větvi release. - Přesunout poznámky k vydání z
## [Unreleased]vCHANGELOG.mddo sekce s datem vydání:## [x.y.z] — YYYY-MM-DD
- Ponechte
## [Unreleased]jako první sekci changelogu pro nadcházející práci. - Ujistěte se, že nejnovější sekce semver v
CHANGELOG.mdje rovna verzipackage.json.
Dokumentace API
- Aktualizace
docs/openapi.yaml:- Soubor
info.versionse musí rovnat verzipackage.json.
- Soubor
- Ověřte příklady koncových bodů, pokud se změnily smlouvy API.
Dokumentace k běhovému prostředí
- Projděte si
docs/ARCHITECTURE.md, zda nedochází k posunu v úložišti/běhovém prostředí. - Projděte si soubor
docs/TROUBLESHOOTING.md, kde naleznete informace o proměnné prostředí a provozním posunu. - Aktualizujte lokalizovanou dokumentaci, pokud se zdrojová dokumentace výrazně změnila.
Automatická kontrola
Před otevřením PR spusťte lokálně ochranu synchronizace:
npm run check:docs-sync
CI také spouští tuto kontrolu v .github/workflows/ci.yml (úloha lint).