Skip to content

Document the component preview field for the dynamic zone picker - #3366

Open
pwizla wants to merge 2 commits into
mainfrom
cms/document-component-screenshot-in-dz-picker
Open

Document the component preview field for the dynamic zone picker#3366
pwizla wants to merge 2 commits into
mainfrom
cms/document-component-screenshot-in-dz-picker

Conversation

@pwizla

@pwizla pwizla commented Jul 31, 2026

Copy link
Copy Markdown
Collaborator

This PR documents the optional preview field that components accept in their info object, which displays a thumbnail for the component in the dynamic zone picker instead of the default icon. The field is documented in the model information reference and the Content Manager dynamic zones section. Note that the field is named preview, not screenshot as the upstream pull request title suggests: it was renamed during review before strapi/strapi#26863 merged.

Direct preview link 👉 here

@pwizla pwizla added the auto-doc-healing Automatically generated documentation PR label Jul 31, 2026
@pwizla pwizla self-assigned this Jul 31, 2026
@strapi-cla

strapi-cla commented Jul 31, 2026

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ pwizla
❌ github-actions[bot]
You have signed the CLA already but the status is still pending? Let us recheck it.

@vercel

vercel Bot commented Jul 31, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
documentation Ready Ready Preview Aug 26, 2026 3:02pm

Request Review

@github-actions github-actions Bot added pr: updated content PRs updating existing documentation content source: CMS internal PRs created by the Strapi core team labels Jul 31, 2026
pwizla added a commit that referenced this pull request Aug 26, 2026
The previous fix was wrong. "shell: bash" expands to
"bash --noprofile --norc -e -o pipefail {0}", which still carries -e, so the run
kept stopping after 3 of 12 checks. Only the explicit "shell: bash {0}" form
drops it. Reproduced with the real scripts against #3366: -e stops at 3 checks
and exits 1, bash {0} runs all twelve and exits 0.
pwizla added a commit that referenced this pull request Aug 26, 2026
…3409)

The previous fix was wrong. "shell: bash" expands to
"bash --noprofile --norc -e -o pipefail {0}", which still carries -e, so the run
kept stopping after 3 of 12 checks. Only the explicit "shell: bash {0}" form
drops it. Reproduced with the real scripts against #3366: -e stops at 3 checks
and exits 1, bash {0} runs all twelve and exits 0.
pwizla added a commit that referenced this pull request Aug 26, 2026
The host list was written with backslash-escaped dots and passed to awk through
-v, where a backslash is a string escape rather than a regex one. awk consumed
it, gawk warned "escape sequence \. treated as plain .", and the dot became a
wildcard: https://strapiXio.evil.com was accepted as an allowed host. Writing
the dots as [.] survives -v untouched.

Verified: the four legitimate hosts still pass, strapiXio.evil.com and
notstrapi.io are now blocked, and the warning that appeared in the #3366 run
summary is gone.
pwizla added a commit that referenced this pull request Aug 26, 2026
The host list was written with backslash-escaped dots and passed to awk through
-v, where a backslash is a string escape rather than a regex one. awk consumed
it, gawk warned "escape sequence \. treated as plain .", and the dot became a
wildcard: https://strapiXio.evil.com was accepted as an allowed host. Writing
the dots as [.] survives -v untouched.

Verified: the four legitimate hosts still pass, strapiXio.evil.com and
notstrapi.io are now blocked, and the warning that appeared in the #3366 run
summary is gone.
pwizla added a commit that referenced this pull request Aug 26, 2026
All twelve checks ran and the verdict was recorded, but the step still failed.
Its exit code is that of its last command, and the last one to run was the
test on UNKNOWN: with no errored check that variable is empty, the test returns
1, and the step fails on a perfectly normal outcome.

The step reports a verdict, it does not pass or fail on it — eligibility is
carried by the output. Reproduced against #3366: same verdict either way, exit 1
before, exit 0 after. The other five steps across both workflows were not
affected but get the same explicit ending, so no step's result depends on
whichever command happens to be last.
The field is named preview, not screenshot: it was renamed upstream
before strapi/strapi#26863 merged. Moved off the Entity Service page,
which is deprecated and unlisted, and which the field has nothing to
do with.
@pwizla pwizla changed the title Document optional component screenshot field for Dynamic Zone picker Document the component preview field for the dynamic zone picker Aug 26, 2026
@pwizla
pwizla marked this pull request as ready for review August 26, 2026 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-doc-healing Automatically generated documentation PR internal PRs created by the Strapi core team pr: updated content PRs updating existing documentation content source: CMS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants