Skip to content

Commit 0e4c808

Browse files
authored
Update Ref Arch setup instructions to include GitHub Automations (#569)
- Relates to CORE-35
1 parent 9e5691c commit 0e4c808

File tree

4 files changed

+53
-5
lines changed

4 files changed

+53
-5
lines changed

_docs-sources/guides/reference-architecture/configuration-guide/index.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ YAML files are space-sensitive. As you edit the file, be sure to retain the corr
189189

190190
If you’re unsure about how to answer any of the questions, email <[email protected]> and let us know!
191191

192-
## Complete the set up process and open a pull request for Gruntwork
192+
## Complete the set up process and open a pull request to engage our GitHub Automations
193193

194194
1. Review your changes. If you notice any errors, correct them, and rerun:
195195

@@ -205,7 +205,31 @@ If you’re unsure about how to answer any of the questions, email <support@grun
205205
git push origin ref-arch-form
206206
```
207207

208-
1. [Open a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). Gruntwork will review the pull request, resolve any open questions or issues, then merge and begin the deployment.
208+
1. [Open a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
209+
210+
## Use Preflight Checks to iterate on your form and fix any configuration issues
211+
212+
![Gruntwork Preflight Checks on GitHub](/img/guides/reference-architecture/configuration-guide/preflight-checks.png)
213+
214+
Once your form is filled in and pushed to GitHub, our GitHub automations will take over. You'll notice a special GitHub check called _Preflight Checks_ that will run against your `reference-architecture-form.yml` file and flag any errors for you directly in your pull request, like so:
215+
216+
![Gruntwork Preflight Checks](/img/guides/reference-architecture/configuration-guide/preflight-checks-preview.png)
217+
218+
You can then locally iterate on your form by editing `reference-architecture-form.yml` on the `ref-arch-form` branch and pushing your changes up to GitHub. Each time you make a new commit and push it, the Gruntwork _Preflight Checks_ will be run against your form.
219+
220+
Keep iterating on your form and pushing new commits up until the Preflight Checks check passes and you see no more error annotations on your pull request.
221+
222+
## Next Steps
223+
224+
Once all your _Preflight Checks_ pass, you can merge your pull request, which will commence your Ref Arch deployment.
225+
226+
Gruntwork engineers are automatically notified of each new Ref Arch deployment, so there's no need to reach out to support just to inform us that your deployment has commenced.
227+
228+
Gruntwork engineers will monitor your deployment and receive notifications about failures and issues that may require intervention to resolve.
229+
230+
Gruntwork engineers rotate through all active deployments to fix up issues preventing them from making forward progress. In general, deployments take "A few days", although there are plenty of variables outside of our control that can occasionally interfere with a deployment, and which may take longer to remediate.
231+
232+
Gruntwork engineers will reach out to you to communicate a status update or next steps if your deployment requires additional intervention to complete.
209233

210234
## Appendix: How to create a secret for the VCS token in AWS Secrets Manager
211235

docs/guides/reference-architecture/configuration-guide/index.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ YAML files are space-sensitive. As you edit the file, be sure to retain the corr
189189

190190
If you’re unsure about how to answer any of the questions, email <[email protected]> and let us know!
191191

192-
## Complete the set up process and open a pull request for Gruntwork
192+
## Complete the set up process and open a pull request to engage our GitHub Automations
193193

194194
1. Review your changes. If you notice any errors, correct them, and rerun:
195195

@@ -205,7 +205,31 @@ If you’re unsure about how to answer any of the questions, email <support@grun
205205
git push origin ref-arch-form
206206
```
207207

208-
1. [Open a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request). Gruntwork will review the pull request, resolve any open questions or issues, then merge and begin the deployment.
208+
1. [Open a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
209+
210+
## Use Preflight Checks to iterate on your form and fix any configuration issues
211+
212+
![Gruntwork Preflight Checks on GitHub](/img/guides/reference-architecture/configuration-guide/preflight-checks.png)
213+
214+
Once your form is filled in and pushed to GitHub, our GitHub automations will take over. You'll notice a special GitHub check called _Preflight Checks_ that will run against your `reference-architecture-form.yml` file and flag any errors for you directly in your pull request, like so:
215+
216+
![Gruntwork Preflight Checks](/img/guides/reference-architecture/configuration-guide/preflight-checks-preview.png)
217+
218+
You can then locally iterate on your form by editing `reference-architecture-form.yml` on the `ref-arch-form` branch and pushing your changes up to GitHub. Each time you make a new commit and push it, the Gruntwork _Preflight Checks_ will be run against your form.
219+
220+
Keep iterating on your form and pushing new commits up until the Preflight Checks check passes and you see no more error annotations on your pull request.
221+
222+
## Next Steps
223+
224+
Once all your _Preflight Checks_ pass, you can merge your pull request, which will commence your Ref Arch deployment.
225+
226+
Gruntwork engineers are automatically notified of each new Ref Arch deployment, so there's no need to reach out to support just to inform us that your deployment has commenced.
227+
228+
Gruntwork engineers will monitor your deployment and receive notifications about failures and issues that may require intervention to resolve.
229+
230+
Gruntwork engineers rotate through all active deployments to fix up issues preventing them from making forward progress. In general, deployments take "A few days", although there are plenty of variables outside of our control that can occasionally interfere with a deployment, and which may take longer to remediate.
231+
232+
Gruntwork engineers will reach out to you to communicate a status update or next steps if your deployment requires additional intervention to complete.
209233

210234
## Appendix: How to create a secret for the VCS token in AWS Secrets Manager
211235

@@ -235,6 +259,6 @@ In the ref arch form, `VCSPATSecretsManagerARN` is where you enter this ARN.
235259
<!-- ##DOCS-SOURCER-START
236260
{
237261
"sourcePlugin": "local-copier",
238-
"hash": "745a1271cf4657c0800489c9de81cac6"
262+
"hash": "3cfd9930ece7baaa5154d8565fcb6ae4"
239263
}
240264
##DOCS-SOURCER-END -->
Loading
Loading

0 commit comments

Comments
 (0)