Skip to content

Commit 3ed538c

Browse files
committed
docs: infrastructure.md: document Pages configuration for docs.yml workflow
Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
1 parent 9418191 commit 3ed538c

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

docs/infrastructure.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,25 @@ regenerated by a project administrator/owner.
6666
|-------|-------|------|--------|----------|--------|
6767
| `PYTHON_CI_GROUP_TOKEN` | Group ([Python](https://gitlab.com/riseproject/python)) | Maintainer | `api`, `read_api`, `read_repository`, `write_repository` | MR pipeline triggers, auto updates/checks | 1 year (April 19th, 2027) |
6868
| `rise-github-package-registry` | Repository deploy token ([wheel_builder](https://gitlab.com/riseproject/python/wheel_builder/-/settings/repository#js-deploy-tokens)) | n/a (deploy token) | `read_package_registry`, `write_package_registry` | Push wheels GitHub → GitLab package registry | 1 year (June 29th, 2027) |
69+
70+
## GitHub Pages Configuration
71+
72+
The `.github/workflows/docs.yml` workflow handles building and deploying
73+
documentation, including providing previews of the docs on a per-PR basis. For
74+
this to work correctly, the following settings need to be configured under
75+
`Settings -> Pages -> Build and deployment` in the repository:
76+
77+
1. `Source` should be set to `Deploy from a branch`
78+
2. `Branch` should be set to `gh-pages` `/(root)`
79+
80+
When this is configured, any changes touching the `docs` folder will trigger a
81+
docs build, where upon completion the `rossjrw/pr-preview-action` will
82+
automatically comment on the PR with a link looking like:
83+
84+
```
85+
https://riseproject-dev.github.io/python-wheels/pr-preview/pr-171/
86+
```
87+
88+
Note that the `gh-pages` branch should be automatically created by the
89+
workflows, but if not it must be created manually with an empty `.nojekyll` file
90+
in the project root to avoid long rebuild times.

0 commit comments

Comments
 (0)