Skip to content

Breaking change to github.com/arduino/go-paths-helper.Path.IsInsideDir #21

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

Closed
per1234 opened this issue May 1, 2023 · 2 comments · Fixed by #22
Closed
Assignees
Labels
conclusion: resolved Issue was resolved topic: documentation Related to documentation for the project type: bug Perceived defect in any part of project

Comments

@per1234
Copy link
Contributor

per1234 commented May 1, 2023

One of the result parameters parameters was removed from the github.com/arduino/go-paths-helper.Path.IsInsideDir method in 657985f

The breaking change to the package API is reasonable, but it was not communicated to the module's users.

I suggest the following remediation measures:

  • Make a 2.0.0 release (as advised here)
  • Document the breaking change in the 2.0.0 release notes
@per1234 per1234 added type: bug Perceived defect in any part of project topic: documentation Related to documentation for the project labels May 1, 2023
@cmaglie
Copy link
Member

cmaglie commented May 8, 2023

We may also re-add the error result (even if it will be always nil) to fix 1.x series.

@cmaglie
Copy link
Member

cmaglie commented May 9, 2023

It looks like there is a lot of work to do for a v2 version: https://go.dev/blog/v2-go-modules

The suggested approach in the blog post will leave the v1 version on the git root and the v2 under the v2/... subdirectory, making the v1 version more prominent which is something I don't like.

IMHO, it's not worth the effort, and we should revert the breaking change by re-adding the missing return error.

@cmaglie cmaglie linked a pull request May 10, 2023 that will close this issue
@per1234 per1234 added the conclusion: resolved Issue was resolved label May 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conclusion: resolved Issue was resolved topic: documentation Related to documentation for the project type: bug Perceived defect in any part of project
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants