History log of /expo/.github/workflows/docs-pr-deploy.yml (Results 1 – 1 of 1)
Revision Date Author Comments
# fe1ef024 17-Jul-2023 Jon Samp <[email protected]>

[docs] Adds docs preview label (#20583)

# Why

We'd like the ability to add a label, then to have GitHub Actions build
the docs and deploy them on AWS S3, where we can preview them quickly
durin

[docs] Adds docs preview label (#20583)

# Why

We'd like the ability to add a label, then to have GitHub Actions build
the docs and deploy them on AWS S3, where we can preview them quickly
during PR review.

This PR adds a GitHub Action (GHA) that gets triggered when added the
"preview" label. The GHA exports/builds the docs and then uploads them
to AWS S3. Then, it comments on the PR with a link to the preview URL.
When merging a PR, another GHA runs to clean up and delete the bucket
that was created when adding the label.

Closes ENG-5683

# How

- Added a `AWS_BUCKET` field to our **deploy.sh** to specify the bucket
to deploy to.
- Edits the search inside the docs to replace `docs.expo.dev` with the
preview URL if the docs are hosted on an aws-style URL.

# Test plan

You should see the docs preview website on this PR! Go check it out.

Also, I opened another PR on top of this one where I confirmed both
pr-deploy and pr-destroy steps (on label add, remove, and merge). See
the screenshots in the comments on this PR:
https://github.com/expo/expo/pull/23545

show more ...