Skip to content

Commit c8f53fc

Browse files
authored
docs: add deployment details (#225)
1 parent c59609a commit c8f53fc

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ BASE_URL=/cadence-docs/
4545
ORGANIZATION_NAME=cadence-workflow
4646
```
4747

48+
#### CNAME
49+
50+
A file `static/CNAME` should be present in order to deploy to a [github pages site that uses a custom domain](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site). I.E. cadenceworkflow.io
51+
This file is created by the deploy action, but if deploying from a local environment, care should be taken to ensure the file exists.
52+
4853
### Deployment
4954

5055
Using SSH:
@@ -67,6 +72,10 @@ If you are using GitHub pages for hosting, this command is a convenient way to b
6772
The release pages rely on data from GitHub that is persisted as json files under `static/data/releases/`.
6873
In order to update the release information for display, this can be done manually or be set up as part of the CI/CD process by running the `scripts/fetch-releases.sh` script. Script uses the [GitHub CLI](https://cli.github.com/) to fetch the release data.
6974

75+
Automatic updates to release data are performed by a github action `fetch-release-data`. Which will check if new data is available, and if so update the release data with the latest information and open a branch named `fetch-release-data` and open a PR if one is not open already.
76+
77+
Manual approval is required before merging and continuing to deployment.
78+
7079
# NPM Registry
7180

7281
Ensure you have a `.npmrc` [file](https://docs.npmjs.com/cli/v9/configuring-npm/npmrc/) configured with `registry=https://registry.npmjs.org/`.

0 commit comments

Comments
 (0)