add deployment notes

happy-software · Aug 7, 2024 · f6d06a2 · f6d06a2
1 parent b6d2e08
commit f6d06a2
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -15,3 +15,11 @@ to your local server.
 ## Run tests locally
 
 `yarn test`
+
+## Deployment
+
+Deployment is done via [gh-pages](https://github.com/tschaub/gh-pages). This publishes files to a `gh-pages` branch on GitHub. 
+
+This is done by the [deploy.yml](.github/workflows/deploy.yml) GitHub Action, which runs automatically on merges to the main branch, or can be manually called in GitHub UI on any branch.
+
+The latest commit SHA of the branch that is deployed will be recorded in a `meta` tag with name `ui-version` in the index.html of the deployed website.