Fix create_github_release crashing when no release notes are given - #759
Merged
Conversation
`release_notes_file_path` is optional, but its `''` fallback is a frozen literal (the file sets `frozen_string_literal: true`), so the `gsub!` that rewrites bracketed GitHub URLs raised `FrozenError`. Use the non-mutating `gsub` instead. Adds specs for the action, which had none.
Collaborator
Generated by 🚫 Danger |
Contributor
Author
|
@AliSoftware Thank you for the light speed PR review. 🙇♂️ |
Contributor
|
You're welcome 🙂 Btw @oguzkocer no need to add |
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
3 participants
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.
The problem
create_github_releaseraises wheneverrelease_notes_file_pathis omitted:release_notes_file_pathis declaredoptional: true, so omitting it is a supported path — but the''fallback it lands on is a frozen literal, because the file setsfrozen_string_literal: true. The next line then callsgsub!on it (the rewrite that turns bracketed GitHub PR/issue URLs into shorthand) and blows up.File.readreturns an unfrozen string, which is why the branch that does read a notes file has never hit this — and why every existing caller in the wild works. The optional path has simply never been exercised.What this PR does
gsuband reassigns. The regex and its behaviour are unchanged.spec/create_github_release_spec.rb, which the action didn't have:gsub+ reassignment is proven equivalent togsub!.Checklist before requesting a review
bundle exec rubocopto test for code style violations and recommendations.specs/*_spec.rb) if applicable.bundle exec rspecto run the whole test suite and ensure all your tests pass.CHANGELOG.mdfile to describe your changes under the appropriate existing###subsection of the existing## Trunksection.MIGRATION.mdfile to describe how the changes will affect the migration from the previous major version and what the clients will need to change and consider.