Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Reorganise deployment info
  • Loading branch information
jystewart authored Oct 18, 2024
1 parent 6f937a0 commit 4ae6bbb
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,17 @@ add it to the file `build-short-urls/pd-short-urls.csv`

There are then two options for deployment:

### Use Github actions

If you're editing the main PD version of this then committing your change will trigger
a deployment.

If using your own clone of this then your repository will need secrets set up for
AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY

With that done, pushing the updated CSV to github (or just updating it using github
on the web) will trigger a deployment.

### Deploy from the command line

Run:
Expand All @@ -66,14 +77,6 @@ This assumes you are:
* running python3
* have the dependencies listed in the requirements.txt file

### Use github actions

The preferred way to do deployments is using github actions. For that to work your
repository will need secrets set up for AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY

With that done, pushing the updated CSV to github (or just updating it using github
on the web) will trigger a deployment.

## Any questions/suggestions

Contact [email protected]

0 comments on commit 4ae6bbb

Please sign in to comment.