Skip to content
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.

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

Implement reference previews #128

Open
MarcoIeni opened this issue Aug 23, 2024 · 0 comments
Open

Implement reference previews #128

MarcoIeni opened this issue Aug 23, 2024 · 0 comments
Assignees

Comments

@MarcoIeni
Copy link
Member

MarcoIeni commented Aug 23, 2024

Set up rendered previous or PRs for the reference repository.

Zulip proposal

Zulip discussion here.

  1. Set up a static website with an S3 bucket to host the content on.
  2. Add the necessary secrets to the reference repo so that a GitHub action can upload the files to the bucket (use oidc instead)?
  3. Add a way to trigger the preview (i.e. store the files to the S3 bucket). Example: this can be done from a workflow_dispatch or from a GH comment in the PR. Example here.
  • The intent is for these previews to only be generated manually via a bot by a team member. They would type something like @rustbot preview in the GH comment).
  • The action that generates the preview will only be on the master branch, so a PR can't change what s3 command is run.

My proposal

Use github pages. Demo here.

@MarcoIeni MarcoIeni self-assigned this Aug 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Review
Development

No branches or pull requests

1 participant