element-hq / element-hq/synapse

Get CI to build docs automatically on pull requests

Open
#10,997 0 comments 0 reactions 0 assignees View on GitHub
P4 S-Tolerable T-Task
Dominant language
Python
Stars
4.6k
Forks
600
Avg merge
5d 22h
Merged PRs (30d)
51

Description

This issue has been migrated from [#10997](https://github.com/matrix-org/synapse/issues/10997).

---

For pull requests that change `/docs` it would be nice to have an action which

- builds the documentation book
- uploads it as an archive
- does not push to GitHub Pages

There is an action [here](https://github.com/dorny/paths-filter) which might detect a change to `/docs`. But a neater way might be to use [`on.pull_request.paths`](https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#onpushpull_requestpaths).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.