Fix shell variable escaping in action.yml snippets (#302)

This commit is contained in:
eric sciple
2026-01-19 13:55:42 -06:00
committed by GitHub
parent 2a203ec742
commit e2c5f1f74a
+12 -14
View File
@@ -91,7 +91,6 @@ main: index.js
# console.log('Hello World'); # console.log('Hello World');
`; `;
/* eslint-disable no-useless-escape -- \$ is required to escape $ in VS Code snippets */
const ACTION_SNIPPET_COMPOSITE_FULL = `name: '\${1:Action Name}' const ACTION_SNIPPET_COMPOSITE_FULL = `name: '\${1:Action Name}'
description: '\${2:What this action does}' description: '\${2:What this action does}'
@@ -116,9 +115,9 @@ runs:
env: env:
INPUT_NAME: \\\${{ inputs.name }} INPUT_NAME: \\\${{ inputs.name }}
run: | run: |
GREETING="Hello \$INPUT_NAME" GREETING="Hello \\$INPUT_NAME"
echo "\$GREETING" echo "\\$GREETING"
echo "greeting=\$GREETING" >> \$GITHUB_OUTPUT echo "greeting=\\$GREETING" >> \\$GITHUB_OUTPUT
`; `;
const ACTION_SNIPPET_COMPOSITE_RUNS = `inputs: const ACTION_SNIPPET_COMPOSITE_RUNS = `inputs:
@@ -142,9 +141,9 @@ runs:
env: env:
INPUT_NAME: \\\${{ inputs.name }} INPUT_NAME: \\\${{ inputs.name }}
run: | run: |
GREETING="Hello \$INPUT_NAME" GREETING="Hello \\$INPUT_NAME"
echo "\$GREETING" echo "\\$GREETING"
echo "greeting=\$GREETING" >> \$GITHUB_OUTPUT echo "greeting=\\$GREETING" >> \\$GITHUB_OUTPUT
`; `;
const ACTION_SNIPPET_COMPOSITE_USING = `# For more on composite actions, see: const ACTION_SNIPPET_COMPOSITE_USING = `# For more on composite actions, see:
@@ -180,9 +179,9 @@ runs:
args: args:
- -c - -c
- | - |
GREETING="Hello \$INPUT_NAME" GREETING="Hello \\$INPUT_NAME"
echo "\$GREETING" echo "\\$GREETING"
echo "greeting=\$GREETING" >> \$GITHUB_OUTPUT echo "greeting=\\$GREETING" >> \\$GITHUB_OUTPUT
`; `;
const ACTION_SNIPPET_DOCKER_RUNS = `inputs: const ACTION_SNIPPET_DOCKER_RUNS = `inputs:
@@ -207,11 +206,10 @@ runs:
args: args:
- -c - -c
- | - |
GREETING="Hello \$INPUT_NAME" GREETING="Hello \\$INPUT_NAME"
echo "\$GREETING" echo "\\$GREETING"
echo "greeting=\$GREETING" >> \$GITHUB_OUTPUT echo "greeting=\\$GREETING" >> \\$GITHUB_OUTPUT
`; `;
/* eslint-enable no-useless-escape */
const ACTION_SNIPPET_DOCKER_USING = `# For more on Docker actions, see: const ACTION_SNIPPET_DOCKER_USING = `# For more on Docker actions, see:
# https://docs.github.com/en/actions/sharing-automations/creating-actions/creating-a-docker-container-action # https://docs.github.com/en/actions/sharing-automations/creating-actions/creating-a-docker-container-action