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

Breaking changes in v3, taskfile/read pkg removed #1958

Open
titpetric opened this issue Dec 14, 2024 · 1 comment
Open

Breaking changes in v3, taskfile/read pkg removed #1958

titpetric opened this issue Dec 14, 2024 · 1 comment
Labels
area: package api Changes related to the usage of Task as a Go package.

Comments

@titpetric
Copy link

Previously a taskfile/read package was provided, which i imported and used for taskfile. This API isn't available today anymore, and a v4 is not tagged.

@task-bot task-bot added the state: needs triage Waiting to be triaged by a maintainer. label Dec 14, 2024
@titpetric titpetric changed the title Breaking changes in v3 Breaking changes in v3, taskfile/read pkg removed Dec 14, 2024
@pd93
Copy link
Member

pd93 commented Dec 15, 2024

Unfortunately, our package API is not currently stable and does not guarantee backwards compatibility. While we generally avoid breaking it on purpose, the CLI is our priority and if a change is made easier by breaking the package API, then we have/will do so.

In the specific case of taskfile/read. This was mostly just a package rename in an effort to improve the intuitiveness of the API surface (read is not a good package name IMO). When updating to the latest version of Task, you should be able to import github.com/go-task/task/v3/taskfile instead and get the same functions. The package for handling the schema/AST directly is now in github.com/go-task/task/v3/taskfile/ast.

It is possible that we may stabilise the package API in the future and this has been discussed a few times (e.g. #121). However, this has not been done in the past because we did not feel it was in a good enough state to do so.

I do think we should consider a section in our documentation where we describe how to use Task as package with explicit warnings about the lack of stability.

@pd93 pd93 added area: package api Changes related to the usage of Task as a Go package. type: question Further information is requested. and removed state: needs triage Waiting to be triaged by a maintainer. type: question Further information is requested. labels Dec 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: package api Changes related to the usage of Task as a Go package.
Projects
None yet
Development

No branches or pull requests

3 participants