Skip to content

Commit d0270be

Browse files
committed
docs
1 parent 8746e72 commit d0270be

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Deploy Production
1+
name: Deploy Website
22

33
on:
44
workflow_dispatch:

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,16 @@ When translating the content to a new language you need to edit the [`i18n/confi
4444

4545
- [Writing CSS](/docs/css.md)
4646

47-
4847
## Deploying the site
4948

50-
The website is set up to deploy itself whenever a new GitHub release is created from the `main` branch:
49+
The website is set up to deploy itself whenever the "Deploy Website" GitHub action is run. This triggers a new deploy from the `main` branch where the website is built, uploaded, and a new GitHub Release is created with a `reference.zip` file containing the contents of the website for loading in the IDE.
50+
51+
1. Go to [Actions](https://github.com/processing/processing-website/actions)
52+
2. Click "Deploy Website" in the left sidebar
53+
3. Click "Run workflow" on the right
54+
4. Fill in the details and click the green "Run workflow" button.
5155

52-
1. Go to [Releases](https://github.com/processing/processing-website/releases)
53-
2. Click "Draft a new release"
54-
3. Choose a tag for this release. This value is not used for much, so you can just use `DD-MM-YYYY`
55-
4. Create the release. [A GitHub action will run](https://github.com/processing/processing-website/actions), which will build the website and upload to the S3 bucket (this may take up to 10-15 minutes).
56+
Note that it's possible to deploy the website with or without making a GitHub release. For this, toggle the checkbox under "Run workflow".
5657

5758
## `keywords.txt`
5859

@@ -66,6 +67,6 @@ The `processing4` repo now has an updated `java/keywords.txt` file.
6667

6768
## Building the site
6869

69-
If you need to manually build the site, you can do it by running `npm run build` from the project source. This command is that runs behind the scenes when deploying a release.
70+
If you need to manually build the site, you can do it by running `npm run build` from the project source. This command is that runs behind the scenes when deploying a release.
7071

7172
It will build from the source and produce the static website in a folder `public`. Once built, the site can run in any static file server.

0 commit comments

Comments
 (0)