https://github.com/rwf2/api.rocket.rs
https://github.com/rwf2/api.rocket.rs
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rwf2/api.rocket.rs
- Owner: rwf2
- Created: 2024-03-01T08:05:38.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T19:52:42.000Z (about 2 years ago)
- Last Synced: 2025-08-05T13:45:50.036Z (11 months ago)
- Language: Shell
- Size: 7.81 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [api.rocket.rs]
Builds the docs for [api.rocket.rs].
## How it works (`build.sh`)
When a commit gets pushed to any branch in [Rocket], a webhook fires, triggering
`./build.sh` that:
- Clones [Rocket] to `_rocket`.
- Creates a worktree for each branch `_build`.
- Builds the docs in parallel in each worktree, if cache is stale.
- Copies each `$worktree/target/doc` to `_output/$branch`.
- Copies `static/*` to `_output/`.
- Uploads `_output` to [api.rocket.rs].
[Rocket]: https://github.com/rwf2/Rocket
[api.rocket.rs]: https://api.rocket.rs