Skip to content

fix(marketplace): cut the description to 110 chars so publish is unblocked - #10

Merged
hyperpolymath merged 1 commit into
mainfrom
fix/marketplace-description-limit
Sep 15, 2026
Merged

hyperpolymath merged 1 commit into
mainfrom
fix/marketplace-description-limit

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

Why

The Marketplace publish form rejects the action with:

Description must be less than 125 characters.

Our description parses to 216 characters, so publication is blocked.

The trap

The folded block scalar >- does not help. GitHub measures the parsed
value, and folding joins the lines into one long string.

A bare grep '^description:' matches the >- marker itself and reports a
length of 2 — a false pass. The correct instrument is:

python3 -c "import yaml; print(len(yaml.safe_load(open('action.yml'))['description']))"

Verification

parsed length verdict
before (negative control) 216 would FAIL
after 110 PASSES

Required Marketplace fields all intact: name (23), author, branding
(shield/blue), runs.using: composite, inputs: [path, strict].

The fuller description remains in README.adoc, which has no length limit.

Note for the release

Marketplace reads action.yml from the release tag, not from main, so
this must ride a new tag (v1.0.1) before the publish form will accept it.

🤖 Generated with Claude Code

https://claude.ai/code/session_01QNjWX2B4FffG7zqMBMui6v

…ocked

GitHub Marketplace rejects an action description of 125 characters or more.
Ours parsed to 216 and blocked publication.

The folded block scalar `>-` does not help: GitHub measures the PARSED value,
and folding joins the lines into one long string. Verified with
yaml.safe_load(open('action.yml'))['description'] -- 216 before, 110 after.
A bare `grep '^description:'` matches the `>-` marker and reports length 2,
which is a false pass; do not measure it that way.

The fuller description lives in README.adoc, which has no length limit.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01QNjWX2B4FffG7zqMBMui6v
@coderabbitai

coderabbitai Bot commented Sep 15, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 21b6d57d-8979-4c1b-b461-0eac8ee21c21

📥 Commits

Reviewing files that changed from the base of the PR and between f93301b and 59c9cd1.

📒 Files selected for processing (1)
  • action.yml

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

📜 Recent review details
🔇 Additional comments (1)
action.yml (1)

9-13: LGTM!

Also applies to: 15-16


📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated the GitHub Action’s Marketplace description to fit within GitHub’s 125-character limit.
    • The revised wording focuses on validating .deed and legacy .a2ml manifests against the DEED grammar, including identity, version, SPDX, and attestation checks.
    • Removed references to scanning mechanics, canonical names, schema versions, and handling of the superseded extension.

Walkthrough

The GitHub Action description was shortened to fit GitHub Marketplace’s 125-character limit. The new text identifies .deed and legacy .a2ml validation and names identity, version, SPDX, and attestation checks.

Changes

Action metadata

Layer / File(s) Summary
Marketplace description limit
action.yml
The action description was shortened to meet the 125-character limit. Comments document the limit. The description omits several previous implementation details.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Bug fix

Merge Risk: ⚪ Minimal · up to 59c9c

The Marketplace description is shortened while the detailed validation documentation remains in README.adoc, so the change is ready to merge.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the change, the reason, the verification method, and the release-tag requirement. However, it does not use the required Summary, Changes, RSR Quality Checklist, Testing, and S… Rewrite the description using the repository template. Add the required headings, list the key changes, complete the RSR Quality Checklist, and include testing details under Testing. Keep the Marketplace length verification and v1.0.1 relea…
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: reducing the Marketplace description length to unblock publication.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description explains the change, the reason, the verification method, and the release-tag requirement. However, it does not use the required Summary, Changes, RSR Quality Checklist, Testing, and Screenshots sections, and it omits the required checklist status.

Resolution

Rewrite the description using the repository template. Add the required headings, list the key changes, complete the RSR Quality Checklist, and include testing details under Testing. Keep the Marketplace length verification and v1.0.1 release-tag requirement.

  • Fix all pre-merge checks with AI

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

A rabbit trims the deed with care
Short words now fit the Marketplace square
Identity, version, SPDX in line
Attestation follows, neat and fine
The manifest hops through validation bright

Comment @coderabbitai help to get the list of available commands.

@sonarqubecloud

Copy link
Copy Markdown

@hyperpolymath
hyperpolymath merged commit ec50907 into main Sep 15, 2026
12 checks passed
@hyperpolymath
hyperpolymath deleted the fix/marketplace-description-limit branch September 15, 2026 19:01
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.

1 participant