Fix SC2215 shellcheck warnings in Playwright prompt heredoc#3568
Fix SC2215 shellcheck warnings in Playwright prompt heredoc#3568
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
@copilot remove the backticks |
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR fixes SC2215 shellcheck warnings in two compiled workflow files by removing backticks around the --output-dir flag reference in markdown documentation embedded within a heredoc. The shellcheck warning was triggered because flags in backticks can be misinterpreted as shell commands.
Key changes:
- Modified
pkg/workflow/sh/playwright_prompt.mdto remove backticks from--output-dir - Recompiled
blog-auditor.lock.ymlandunbloat-docs.lock.ymlto propagate the change
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| pkg/workflow/sh/playwright_prompt.md | Removed backticks from --output-dir reference to prevent SC2215 warning |
| .github/workflows/blog-auditor.lock.yml | Regenerated workflow file reflecting source markdown changes |
| .github/workflows/unbloat-docs.lock.yml | Regenerated workflow file reflecting source markdown changes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Playwright Output Directory | ||
|
|
||
| **IMPORTANT**: When using Playwright tools to take screenshots or generate files, **all output files are automatically saved to `/tmp/gh-aw/mcp-logs/playwright/`**. This is the Playwright `--output-dir` and you can find any screenshots, traces, or other files generated by Playwright in this directory. | ||
| **IMPORTANT**: When using Playwright tools to take screenshots or generate files, **all output files are automatically saved to `/tmp/gh-aw/mcp-logs/playwright/`**. This is the Playwright --output-dir and you can find any screenshots, traces, or other files generated by Playwright in this directory. |
There was a problem hiding this comment.
The removal of backticks around --output-dir creates inconsistent markdown formatting. The same line still contains backticks around `/tmp/gh-aw/mcp-logs/playwright/`, which could also trigger shellcheck warnings.
Consider one of these approaches for consistency:
- Suppress SC2215 in the shellcheck disable directive (preferred): Update
shellcheckDisableBackticksconstant inpkg/workflow/sh.gofrom"# shellcheck disable=SC2006,SC2287\n"to"# shellcheck disable=SC2006,SC2215,SC2287\n"and revert this change - Remove all backticks: Also remove backticks from the path:
all output files are automatically saved to /tmp/gh-aw/mcp-logs/playwright/
The first approach is preferred because:
- It's consistent with how SC2006/SC2287 are handled
- It preserves markdown code formatting for documentation
- Other
.mdfiles inpkg/workflow/sh/use backticks extensively (seegithub_context_prompt.md,edit_tool_prompt.md,pr_context_prompt.md)
| **IMPORTANT**: When using Playwright tools to take screenshots or generate files, **all output files are automatically saved to `/tmp/gh-aw/mcp-logs/playwright/`**. This is the Playwright --output-dir and you can find any screenshots, traces, or other files generated by Playwright in this directory. | |
| **IMPORTANT**: When using Playwright tools to take screenshots or generate files, **all output files are automatically saved to `/tmp/gh-aw/mcp-logs/playwright/`**. This is the Playwright `--output-dir` and you can find any screenshots, traces, or other files generated by Playwright in this directory. |
Shellcheck flagged
--output-dirin backticks within heredoc content as potential command flags (SC2215). The text was markdown documentation, not shell code.Changes
pkg/workflow/sh/playwright_prompt.md:`--output-dir`→--output-dirblog-auditor.lock.yml,unbloat-docs.lock.ymlRemoving the backticks prevents shellcheck from misinterpreting markdown formatting as shell syntax within the heredoc.
Eliminates 2 SC2215 warnings. No functional changes.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.