Skip to content

DOC: minor update for the readme #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 25, 2025
Merged

DOC: minor update for the readme #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d843cd
Update to the redirect action has been made.
bsipocz Jul 19, 2025
0f543b8
Mention domain option explicitly; mention redirects
stefanv Jul 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@
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`.
`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).
pages). It follows redirects, and returns the final result.


## Usage

Expand All @@ -22,8 +24,6 @@ Action](https://github.com/scientific-python/circleci-artifacts-redirector-actio
to automatically provide that link in the status of your GH preview
build.

If you replace `output.circle-artifacts.com` with
`circle.scientific-python.dev`, the requests will go through this
proxy (see `worker.js`), and will render pages correctly, as described above.

**TODO:** Update `circleci-artifact-redirector-action` to accept a different base domain.
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.