Summary
When we ship the stable v2.0.0 release, the API docs workflow (.github/workflows/api-docs.yml) should publish from main instead of develop so that the published docs match the latest stable release.
Changes needed
-
In api-docs.yml, change the trigger branch:
yaml on: push: branches: [main] # was: [develop]
-
Consider whether to also publish docs on develop pushes to a separate preview URL (e.g., a /dev/ path or a separate GitHub Pages environment), or only publish from main.
When
This should be done as part of the v2.0.0 stable release process, not before — we still want docs published from develop during the beta/rc phase.
Related
- Part of the v2.0.0 release checklist
Summary
When we ship the stable v2.0.0 release, the API docs workflow (.github/workflows/api-docs.yml) should publish from main instead of develop so that the published docs match the latest stable release.
Changes needed
In api-docs.yml, change the trigger branch:
yaml on: push: branches: [main] # was: [develop]Consider whether to also publish docs on develop pushes to a separate preview URL (e.g., a
/dev/path or a separate GitHub Pages environment), or only publish frommain.When
This should be done as part of the v2.0.0 stable release process, not before — we still want docs published from
developduring the beta/rc phase.Related