Skip to content

Commit 8adafb5

Browse files
authored
Merge pull request clue#146 from clue-labs/continuous-deployment
Update documentation with continuous deployment instructions
2 parents 4272cf6 + 4e1f8e3 commit 8adafb5

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ make clean
5252
Once built (see previous "Build" section), you can simply deploy the `build/`
5353
directory behind your favorite web server (Apache + PHP-FPM etc.).
5454

55-
Additionally, this should be deployed behind a reverse proxy (nginx) that is
56-
responsible for HTTPS certificate handling and forcing HTTPS redirects.
55+
Additionally, this should be deployed behind a reverse proxy (nginx) or CDN (Bunny CDN)
56+
that is responsible for HTTPS certificate handling and forcing HTTPS redirects.
5757

5858
Additionally, Apache has been configured to cache static files for 1 day.
5959

@@ -64,8 +64,16 @@ the `live` branch like this:
6464
make deploy
6565
```
6666

67-
## Auto-Deployment
67+
## Continuous Deployment
6868

69-
Any time a commit is merged (such as when a PR is merged), GitHub actions will
70-
automatically build and deploy the website. This is done by running the above
71-
deployment script (see previous chapter).
69+
We use continuous deployment to keep this website up to date. Any time a commit
70+
is pushed (such as when a PR is merged), GitHub actions will automatically build
71+
and deploy the website. This is done by running the above deployment script (see
72+
previous chapter).
73+
74+
This CI/CD process requires a one-time setup that involves the following steps:
75+
First, set up the project on the web hosting infrastructure with a `public/`
76+
docroot. Next, configure the hosting to pull from this repository and set up a
77+
matching read-only deploy key in this repository. Finally, set up a webhook in
78+
this repository to trigger a deployment on any `push` event to the hosting
79+
platform.

0 commit comments

Comments
 (0)