You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9Lines changed: 9 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,6 +45,11 @@ BASE_URL=/cadence-docs/
45
45
ORGANIZATION_NAME=cadence-workflow
46
46
```
47
47
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
+
48
53
### Deployment
49
54
50
55
Using SSH:
@@ -67,6 +72,10 @@ If you are using GitHub pages for hosting, this command is a convenient way to b
67
72
The release pages rely on data from GitHub that is persisted as json files under `static/data/releases/`.
68
73
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.
69
74
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
+
70
79
# NPM Registry
71
80
72
81
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