Skip to content

Commit

Permalink
fix: add Publishing workflow to README
Browse files Browse the repository at this point in the history
closes #12
  • Loading branch information
shazron committed Sep 15, 2020
1 parent d8e4129 commit d2e8e12
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,26 @@ Example:
GATSBY_LAUNCH_SRC=https://your.adobe.launch.url.here
GATSBY_LAUNCH_SRC_INCLUDE_IN_DEVELOPMENT=true
```
### Publishing to Github Pages (Dev)

On every commit to the `master` branch, the site will be built to Github Pages automatically, for you to preview as a development version.

`Github Contributors component`: this will use the Github token automatically provided by the Github Action to retrieve data.
`Feedback component`: no environmental variable should be set since Github Pages should only be for development purposes.

### Publishing to Azure Storage Static Websites (Production)

This is a pull request flow: a pull request must be approved, and tagged with `deploy` or `deploy:dev` labels.
The Github label `deploy` will deploy the site to a `production` blob, while the Github label `deploy:dev` will deploy the site to a `production` blob

**Pre-requisites:**
1. Create a Github label called `deploy` if it does not exist
2. Create a Github label called `deploy:dev` if it does not exist
3. Add a Azure Blob Storage connection string Github Secret for `production` called `AZURE_PROD_CONNECTION_STRING`
4. Add a Azure Blob Storage connection string Github Secret for `development` called `AZURE_DEV_CONNECTION_STRING`
4. Add a Adobe Launch URL Github Secret called `GATSBY_LAUNCH_URL` (see section above for the Feedback component)
6. The Pull Request must be on a branch in the same repo (this is a Github Actions security restriction for secrets access)
7. The person initiating the Pull Request must be have a `Contributor` role to the repo (because of the previous requirement)

### Global Navigation

Expand Down

0 comments on commit d2e8e12

Please sign in to comment.