Repository navigation
Release notes within the Gallery's limit, measured by the rehearsal - #8
Merged
Merged
Conversation
… a rehearsal check for it The v0.27.0 upload was refused with a 400: ReleaseNotes may not exceed 10,600 characters, and the manifest carried every version since 0.1.0 (11,319). The notes now keep the newest three versions and point at CHANGELOG.md, which ships in the package, for the rest. Build/Publish-Module.ps1 -WhatIf measures the notes, so the limit is met locally instead of at upload.
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
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.
Summary
The
v0.27.0release run passed every gate and then failed at the upload: the Gallery answered 400, "A package's ReleaseNotes property extracted from the PowerShell manifest may not be more than 10600 characters long". The manifest's notes carried every version since 0.1.0 and the 0.27.0 entry took them to 11,319 characters. Nothing is on the Gallery for 0.27.0; it still has 0.26.0.This trims the notes and makes the release rehearsal measure them, so the limit is met locally rather than discovered at upload.
Changes
IntuneScriptLab.psd1.ReleaseNoteskeeps 0.27.0, 0.26.0 and 0.25.0 (2,673 characters) and ends with a pointer toCHANGELOG.mdfor 0.1.0 to 0.24.0. The changelog already holds every one of those entries, and it ships in the package.Build/Publish-Module.ps1. The manifest checks now fail whenReleaseNotesexceeds 10,600 characters, naming the length and the limit. Against the manifest as tagged the rehearsal stops with "The manifest's ReleaseNotes is 11319 characters; the Gallery accepts at most 10600"; against the trimmed one it stages, verifies and stops at the publish as before.CHANGELOG.md. A line under 0.27.0 recording this.Why the rehearsal missed it: it checks the manifest's URIs, description and tags, stages the allowlisted package, imports it in a fresh process and verifies exports, a sample analysis, the analyzer rules and the help, then stops before the upload. The notes length is a Gallery rule enforced only on upload, and nothing local measured it until now.
After merge
The
v0.27.0tag points at the merge of #7, whose manifest the Gallery refuses, so the tag has to move to the merge of this pull request before the release workflow can succeed. Nothing was published under 0.27.0, so the version number is still free:release.ymlre-runs every gate on the tag, checks that it matchesModuleVersion, and publishes.