Skip to content

Commit

Permalink
add some "documentation" to the workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
alifeee committed Aug 26, 2024
1 parent 3305cfe commit 1ccd4ea
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/pull-request-preview-cleanup.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Remove preview from surge
# see `pull-request-preview.yml` for more context
name: Clean up pull request surge preview

on:
Expand Down
20 changes: 20 additions & 0 deletions .github/workflows/pull-request-preview.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,23 @@
# Deploy pull requests to surge, so multiple previews can exist at once
# The deployments API is used to make the deployments visible in the pull request
# https://surge.sh/
# to install surge:
# $ npm install --global surge
# to log in to surge or create an account, run
# $ surge
# to publish a folder as a static site, run
# $ surge --project <folder> --domain <example28928.surge.sh>
# or
# $ surge <folder>
# to remove a site, run
# $ surge teardown <example28928.surge.sh>
# to list active sites, run
# $ surge list
# this workflow requires two secrets: SURGE_LOGIN (the email you use above) and SURGE_TOKEN, generated with
# $ surge token
# note: the PDFs are not deployed, as they turn a ~60mb site into a ~600mb site.
# workflow modified from https://sanderknape.com/2020/05/deploy-pull-requests-github-actions-deployments/

name: Deploy pull request preview to surge

on:
Expand Down

0 comments on commit 1ccd4ea

Please sign in to comment.