Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump firtool-resolver to 1.1.0 #3696

Merged
merged 1 commit into from Dec 19, 2023
Merged

Bump firtool-resolver to 1.1.0 #3696

merged 1 commit into from Dec 19, 2023

Conversation

jackkoenig
Copy link
Contributor

This is sort of an BugFix to an unreleased API (added after 6.0.0-RC1), see the Release Notes for how this changes the behavior of FIRTOOL_PATH in a desirable way.

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Bugfix
  • Dependency update

Desired Merge Strategy

  • Squash

Release Notes

The logic for

  • If FIRTOOL_PATH is set, the --version regex failing no longer will return fail, instead it will set version to <unknown>.
  • If FIRTOOL_PATH is set and something fails (firtool not found or cannot execute the binary), then the error will be returned rather than firtool-resolver falling back to fetching the default version.
  • Errors from running firtool will be logged and returned rather than unconditionally turned into "Firtool binary not on FIRTOOL_PATH".

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.5.x, 3.6.x, or 5.x depending on impact, API modification or big change: 6.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

@jackkoenig jackkoenig added the Dependency Update Updates a dependency, will be included in release notes label Dec 19, 2023
Copy link
Member

@dtzSiFive dtzSiFive left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not performed the reviewer checklist, apologies.

However, I did test that this works for me using FIRTOOL_PATH pointing to a firtool with a non-release-tag firtool version string, as well as when not setting FIRTOOL_PATH and the downloaded executable does not work (producing nice diagnostic).

LGTM, thanks!

@jackkoenig jackkoenig merged commit 54fb8ea into main Dec 19, 2023
17 checks passed
@jackkoenig jackkoenig deleted the bump-firtool-resolver branch December 19, 2023 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dependency Update Updates a dependency, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants