Skip to content

Commit 22c962a

Browse files
authored
Merge pull request #386 from code-dot-org/update-readme
update cicd readme with ruby version fix
2 parents 60bb9af + ec2080a commit 22c962a

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

cicd/README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,29 @@ By setting the `TARGET_BRANCH` you can create a new CI/CD pipeline that watches
7474
TARGET_BRANCH=mybranch cicd/2-cicd/deploy-cicd.sh
7575
```
7676

77-
## Debugging `template.yml.erb`
77+
## Debugging & Troubleshooting
78+
79+
### Debugging `template.yml.erb`
80+
7881
If you are are updating the template file and don't want to wait for a full deploy cycle to validate the syntax, you can do the following from `cicd/3-app/javabuilder`:
82+
7983
```
8084
erb -T - template.yml.erb > app-template-test.yml
8185
cfn-lint app-template-test.yml
8286
```
87+
8388
This will run cloudformation lint on you template changes and give you a quicker feedback cycle when fixing up syntax.
84-
Just delete app-template-test.yml when you are done.
89+
Just delete app-template-test.yml when you are done.
90+
91+
### Resolving "Error when retrieving credentials" when running deploy commands
92+
93+
Because of some nuances of our AWS SSO integration and tooling, you might need to temporarily change Ruby versions when running scripts that interact with the AWS CLI. You might receive an error like the following.
94+
95+
```
96+
Error when retrieving credentials from custom-process: rbenv: aws-google: command not found
97+
98+
The `aws-google' command exists in these Ruby versions:
99+
2.7.5
100+
```
101+
102+
If this occurs, you can simply run `rbenv local 2.7.5` or whatever version is suggested (should be the same version used in the code-dot-org/code-dot-org repository) and try running the script again.

0 commit comments

Comments
 (0)