postalserver / docs

📚 Documentation for the Postal mail server!

https://docs.postalserver.io

136 stars 59 forks source link

Add preview URLs on Pull Requests from "surge.sh" #6

Closed jaydrogers closed 3 years ago

jaydrogers commented 3 years ago

What does this PR do

This adds the Github Action that will build preview URLs for the documentation

Example

See how this works on this example pull request: https://github.com/jaydrogers/docs/pull/2

More information

Here is the Github Action that is added: https://github.com/marketplace/actions/surge-pr-preview

TODO before merging

A surge_token needs to be create for this to work. To do this, you will need to do this on your local machine:

[x] Install Surge on your computer (npm install --global surge)
[x] Create an account from the CLI (surge login)
[x] Create your account (follow the prompts)
[x] Generate a token (surge token)
[x] Add the token to Gitlab Secrets (variable is: surge_token)

github-actions[bot] commented 3 years ago

🎊 PR Preview 9054de23cd6543258feae7ec5c1151549588e576 has been successfully built and deployed to https://postalserver-docs-preview-pr-6.surge.sh

:clock1: Build time: 62.842s

_{🤖 By surge-preview}