Skip to content

docs: avoid direct shell interpolation of Codex output#24

Merged
masterkain merged 1 commit into
icoretech:mainfrom
SalmonPlays:docs-safe-output-examples
Jun 4, 2026
Merged

docs: avoid direct shell interpolation of Codex output#24
masterkain merged 1 commit into
icoretech:mainfrom
SalmonPlays:docs-safe-output-examples

Conversation

@SalmonPlays
Copy link
Copy Markdown
Contributor

Summary

  • Route two README examples through env before printing Codex output.
  • Avoid splicing generated output directly into run: script bodies.

Why

GitHub expressions are expanded before the shell runs. Passing generated Codex output through an environment variable keeps the examples safer for multiline or shell-sensitive output and matches the pattern already used in other examples in this README.

Testing

  • Docs-only change.
  • Previewed the rendered README in the GitHub web editor.

Route Codex output through an environment variable before printing it so examples do not splice generated text directly into a shell script.
@masterkain masterkain merged commit 93e7597 into icoretech:main Jun 4, 2026
masterkain added a commit that referenced this pull request Jun 4, 2026
@masterkain
Copy link
Copy Markdown
Member

merged icoretech/codex-action#24 as 93e7597; added follow-up 4199454 for the existing README markdownlint spacing failure

thanks for reporting and fixing this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants