https://github.com/scientific-python/circleci-proxy
Proxy CircleCI pages so they render as if served on a standard static server
https://github.com/scientific-python/circleci-proxy
Last synced: 2 months ago
JSON representation
Proxy CircleCI pages so they render as if served on a standard static server
- Host: GitHub
- URL: https://github.com/scientific-python/circleci-proxy
- Owner: scientific-python
- License: mit
- Created: 2025-07-18T22:34:20.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-07-25T00:27:53.000Z (8 months ago)
- Last Synced: 2025-10-31T06:40:01.254Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# CircleCI Proxy
CircleCI is a useful service for previewing document builds. However,
by default their artifact server behaves differently from a standard
static pages server, in that it does not render `foo/bar` from
`foo/bar/index.html`. They store files on S3, and certain URLs may
also redirect, causing CORS issues.
This CloudFlare Worker proxy fixes that, by fetching missing `foo/bar`
pages from `foo/bar/index.html`. It also tries `foo/bar.html`, just in
case (e.g., this is useful for static page builds in older versions of
the `mystmd` document engine, which did not yet provide `index.html`
pages). It follows redirects, and returns the final result.
## Usage
Build artifacts are served at a URL of the form:
https://output.circle-artifacts.com/output/job/fdfc47bf-4b9c-47a7-84cc-f494620a6004/artifacts/0/docs/_build/html/index.html
You can use the [CircleCI Artifacts Redirector
Action](https://github.com/scientific-python/circleci-artifacts-redirector-action)
to automatically provide that link in the status of your GH preview
build.
Using its `domain` option, replace `output.circle-artifacts.com` with
`circle.scientific-python.dev` to send requests through this proxy,
which will render routes correctly, as described above.