Skip to content

Commit 06be1cb

Browse files
authored
chore(docs): Update documentation on Automation Workflow Configuration (#1619)
1 parent 54a5375 commit 06be1cb

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

deploy/README.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,3 @@ From the `deploy` folder:
158158
-H 'Content-Type: application/json' \
159159
-d '{ "pathToFile": "/folder/path/to/copy/file/<environment>_dump_<timestamp>.sql" }'
160160
```
161-
162-
## GitHub Workflow Automation Configuration
163-
164-
- The `jwt-signing-key.pem` file should be located in the project root folder. Obtain `ansible-vault-password.txt` from a project administrator and place it in the `deploy` folder. From within the `deploy` folder, you can run `ansible-vault view --vault-password-file ansible-vault-password.txt files/jwt-signing-key.pem.enc > ../jwt-signing-key.pem` to decrypt the configuration file.
165-
- The `AUTOMATION_CALLBACK_FQDN` environment variable in the environment configuration file should be a **fully qualified domain name** that is accessible from the github workflow server pointing at the running instance of aria-at-app. For local development testing of these features, a forwarding proxy server like `ngrok` is recommended: `npx ngrok http 3000 --host-header=rewrite` will setup a server forwarding to your local 3000 development port. You can then use the domain it gives you when launching the app:
166-
`AUTOMATION_CALLBACK_FQDN=128935b17294.ngrok.app yarn dev`

docs/automation.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Automation setup and configuration
2+
3+
This project makes use of an external github repository [aria-at-gh-actions-helper](https://github.com/bocoup/aria-at-gh-actions-helper) to launch github actions that run the automation suite.
4+
More documentation about the tools used in that repository are in it's [README](https://github.com/bocoup/aria-at-gh-actions-helper/README.md).
5+
This repository also has a second copy [aria-at-gh-actions-helper-dev](https://github.com/bocoup/aria-at-gh-actions-helper-dev) which is used in the staging or local environments by default to not get in the way of the queue for the live service.
6+
7+
## GitHub Workflow Automation Configuration
8+
9+
- The `jwt-signing-key.pem` file should be located in the project root folder. Obtain `ansible-vault-password.txt` from a project administrator and place it in the `deploy` folder. From within the `deploy` folder, you can run `ansible-vault view --vault-password-file ansible-vault-password.txt files/jwt-signing-key.pem.enc > ../jwt-signing-key.pem` to decrypt the configuration file.
10+
- The `AUTOMATION_CALLBACK_FQDN` environment variable in the environment configuration file should be a **fully qualified domain name** that is accessible from the github workflow server pointing at the running instance of aria-at-app.
11+
- For **local development** testing of these features, a forwarding proxy server like `ngrok` is recommended: `npx ngrok http 3000 --host-header=rewrite` will setup a server forwarding to your local 3000 development port. You can then use the domain it gives you when launching the app: `AUTOMATION_CALLBACK_FQDN=128935b17294.ngrok.app yarn dev`

0 commit comments

Comments
 (0)