File tree Expand file tree Collapse file tree 4 files changed +32
-3
lines changed Expand file tree Collapse file tree 4 files changed +32
-3
lines changed Original file line number Diff line number Diff line change 11---
22slug : /reference/environment
3- sidebar_position : 4
3+ sidebar_position : 5
44---
55
66# Environment Reference
Original file line number Diff line number Diff line change 1+ ---
2+ slug : /reference/package
3+ sidebar_position : 2
4+ ---
5+
6+ # Package API
7+
8+ :::warning
9+
10+ ** _ Task's package API is still experimental and subject to breaking changes._ **
11+
12+ This means that unlike our CLI, we may make breaking changes to the package API
13+ in minor (or even patch) releases. We try to avoid this when possible, but it
14+ may be necessary in order to improve the overall design of the package API.
15+
16+ In the future we may stabilize the package API. However, this is not currently
17+ planned. For now, if you need to use Task as a Go package, we recommend pinning
18+ the version in your ` go.mod ` file. Where possible we will try to include a
19+ changelog entry for breaking changes to the package API.
20+
21+ :::
22+
23+ Task is primarily a CLI tool that is agnostic of any programming language.
24+ However, it is written in Go and therefore can also be used as a Go package too.
25+ This can be useful if you are already using Go in your project and you need to
26+ extend Task's functionality in some way.
27+
28+ The full generated documentation for the package API is available on
29+ [ pkg.go.dev] ( https://pkg.go.dev/github.com/go-task/task/v3 ) .
Original file line number Diff line number Diff line change 11---
22slug : /reference/schema
3- sidebar_position : 2
3+ sidebar_position : 3
44toc_min_heading_level : 2
55toc_max_heading_level : 5
66---
Original file line number Diff line number Diff line change 11---
22slug : /reference/templating/
3- sidebar_position : 3
3+ sidebar_position : 4
44toc_min_heading_level : 2
55toc_max_heading_level : 5
66---
You can’t perform that action at this time.
0 commit comments