fix: Disable interpolation of HEREDOC strings containing runner hook scripts #4333
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Peter-Sh
changed the title
Interpolation was applied within the user-data.sh context, causing
unexpected empty values for variables and other unintentend effects.
While this behavior might be useful in certain cases, it requires
consistently escaping everything in hook scripts. This approach feels
error-prone and unintuitive.
For example, the following configuration will echo an empty string and
the date of string interpolation, but not the date of the job's start:
```
runner_hook_job_started: |
echo $GITHUB_WORKSPACE
echo $(date)
```
npalm
pushed a commit
that referenced
this pull request
Jan 9, 2025
🤖 I have created a release *beep* *boop* --- ## [6.1.0](philips-labs/terraform-aws-github-runner@v6.0.1...v6.1.0) (2025-01-09) ### Features * **packer:** Allow passing in an instance_profile to packer ([#4278](https://github.com/philips-labs/terraform-aws-github-runner/issues/4278)) ([bb7346b](philips-labs/terraform-aws-github-runner@bb7346b)) ### Bug Fixes * Disable interpolation of HEREDOC strings containing runner hook scripts ([#4333](https://github.com/philips-labs/terraform-aws-github-runner/issues/4333)) ([2622589](philips-labs/terraform-aws-github-runner@2622589)) * **lambda:** bump the aws group in /lambdas with 6 updates ([#4336](https://github.com/philips-labs/terraform-aws-github-runner/issues/4336)) ([1282e11](philips-labs/terraform-aws-github-runner@1282e11)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: forest-releaser[bot] <80285352+forest-releaser[bot]@users.noreply.github.com>
|
Thanks for this! Learned something new today :P |
npalm
pushed a commit
that referenced
this pull request
Jan 27, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Interpolation was applied within the user-data.sh context, causing unexpected empty values for variables and other unintended effects.
While this behavior might be useful in certain cases, it requires consistently escaping everything in hook scripts. This approach feels error-prone and unintuitive.
For example, the following configuration will echo an empty string and the date of string interpolation, but not the date of the job's start:
This PR disables interpolation of the hook script contents when they are being written to the file.
Also the link in user-data.sh to GitHub start/completed docs has been updated.