fix: the Marketplace description was too long to publish, and nothing said so - #194
Merged
Merged
Conversation
… said so #191 rewrote the action.yml description to match the new README. At 129 characters it exceeds the Marketplace limit of 125, so GitHub refused to publish v0.10.3 to the listing: Your action.yml needs changes before it can be published. Description must be less than 125 characters. The failure is silent from the repository's side. The release succeeds, npm updates, the tag is fine, and the Marketplace page simply keeps whatever description it had before. I checked the page afterwards, saw the old text, and guessed it was a cache. It was not. Shortened to 116 characters, keeping the two things that earn their place: the file names, which are the concrete hook, and that it closes nothing. A test now asserts the length, because this is not the kind of limit anyone remembers. Verified by reverting the long description and watching it fail.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What happened
#191 rewrote the
action.ymldescription to match the new README. At 129characters it exceeds the Marketplace limit of 125, so GitHub refused to
publish v0.10.3 to the listing:
The failure is invisible from the repository side. The release succeeds, npm
updates, the tag is correct, and the Marketplace page just keeps the description
it already had. I checked the page after releasing, saw the two-month-old text,
and guessed it was a cache. It was not; it was this.
The fix
116 characters, keeping the two things that earn their place: the file names,
which are the concrete hook, and that it closes nothing.
The guard
packages/action/test/actionMetadata.test.tsnow asserts the length. Nobodyremembers a limit like this, and the only feedback GitHub gives is on a page you
have to go and look at.
Verified the test actually catches it by restoring the 129-character string and
watching it fail, rather than trusting that it would.
Verification
pnpm build && pnpm test && pnpm typecheck && pnpm lint && pnpm format:check,all green. 462 tests, up from 461.