Skip to content

Commit

Permalink
Describe use of actions-riff-raff in readme
Browse files Browse the repository at this point in the history
When deploying a static site recently for
[datawrapper-import](https://github.com/guardian/datawrapper-import), it
wasn’t clear to me that the repository needed to have the necessary
access for Riff Raff to successfully write files for the
`deploy:datawrapper-import` project. Hopefully this message makes it
clearer that that access needs to be set up when setting up a new static
site.
  • Loading branch information
emdash-ie committed Jun 25, 2024
1 parent 33c5f0f commit ea482bb
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,14 @@ jobs:
guActionsRiffRaffRoleArn: ${{ secrets.GU_RIFF_RAFF_ROLE_ARN }}
```
Each run of actions-static-site uses actions-riff-raff to create a new build in
a Riff Raff project which deploys your static site. This allows you to configure
deployment as usual using Riff Raff, for example by setting up continuous
deployment to deploy any new builds on the main branch. It also means your
repository needs to have the necessary access to write to that Riff Raff project
(`deploy::<app>`).


## Inputs

### **app** `string` (required):
Expand Down

0 comments on commit ea482bb

Please sign in to comment.