Skip to content

Commit ec2080a

Browse files
update cicd readme with ruby version fix
1 parent 56e8854 commit ec2080a

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
@@ -72,11 +72,29 @@ By setting the `TARGET_BRANCH` you can create a new CI/CD pipeline that watches
7272
TARGET_BRANCH=mybranch cicd/2-cicd/deploy-cicd.sh
7373
```
7474

75-
## Debugging `template.yml.erb`
75+
## Debugging & Troubleshooting
76+
77+
### Debugging `template.yml.erb`
78+
7679
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`:
80+
7781
```
7882
erb -T - template.yml.erb > app-template-test.yml
7983
cfn-lint app-template-test.yml
8084
```
85+
8186
This will run cloudformation lint on you template changes and give you a quicker feedback cycle when fixing up syntax.
82-
Just delete app-template-test.yml when you are done.
87+
Just delete app-template-test.yml when you are done.
88+
89+
### Resolving "Error when retrieving credentials" when running deploy commands
90+
91+
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.
92+
93+
```
94+
Error when retrieving credentials from custom-process: rbenv: aws-google: command not found
95+
96+
The `aws-google' command exists in these Ruby versions:
97+
2.7.5
98+
```
99+
100+
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)