Remove notes-file from create-release - #8
Merged
Conversation
Notes are written when the draft is published. The release editor is a real text area with a preview, in front of the draft being reviewed, and whoever would pass notes in is the same person about to open it. Passing them in also means collecting them in a workflow_dispatch input, which is a single-line box showing barely a phrase. Removing an input is breaking by ADR-0006. This one shipped in 1.3.0 earlier today and had one consumer, whose change to stop passing it lands alongside this, so no caller is broken.
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.
Notes are written when the draft is published. The release editor is a real
text area with a preview, in front of the draft being reviewed — and whoever
would pass notes in is the same person who is about to open it.
Passing them in also means collecting them somewhere, and in practice that is
a
workflow_dispatchinput: a single-line box that shows barely a phrase.Removed from
bin/create-release.shand the action.--generate-notesstillopens the draft with GitHub's commit list, which is the right starting point
for someone writing above it.
Released as a minor, by exception
Removing an input is a major change by
ADR-0006. Shipping
this as 1.4.0 is a deliberate exception, recorded in the changelog:
create-releaseanywhere in the organization iscaltechlibrary/CL-web-components, and its change to stop passing it landsin lockstep
Once they do, the rule applies as written.
Tested
Against a scratch repository: the dry run prints the expected
gh release create, and--notes-fileis now rejected with exit 2.shellcheck --severity=styleclean, README-documents-every-input passes forall seven actions.