Skip to content

Commit e7a6de6

Browse files
authored
chore: add package API changes to changelog and add gorelease tool (go-task#2055)
* chore: add package API changes to changelog and add gorelease tool * chore: use bullet points instead of a paragraph
1 parent ff8c913 commit e7a6de6

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

CHANGELOG.md

+16
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,22 @@
1616
experiment with an invalid value (#1979, #2049 by @pd93).
1717
- Refactored the experiments package and added tests (#2049 by @pd93).
1818

19+
#### Package API
20+
21+
Unlike our CLI tool,
22+
[Task's package API is not currently stable](https://taskfile.dev/reference/package).
23+
In an effort to ease the pain of breaking changes for our users, we will be
24+
providing changelogs for our package API going forwards. The hope is that these
25+
changes will provide a better long-term experience for our users and allow to
26+
stabilize the API in the future. #121 now tracks this piece of work.
27+
28+
- [`task.InitTaskfile`](https://pkg.go.dev/github.com/go-task/task/v3#InitTaskfile)
29+
(#2011, ff8c913 by @HeCorr and @pd93)
30+
- No longer accepts an `io.Writer` (output is now the caller's
31+
responsibility).
32+
- The path argument can now be a filename OR a directory.
33+
- The function now returns the full path of the generated file.
34+
1935
## v3.41.0 - 2025-01-18
2036

2137
- Fixed an issue where dynamic variables were not properly logged in verbose

Taskfile.yml

+16
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,22 @@ tasks:
120120
cmds:
121121
- go install github.com/goreleaser/goreleaser/v2@latest
122122

123+
gorelease:install:
124+
desc: "Installs gorelease: https://pkg.go.dev/golang.org/x/exp/cmd/gorelease"
125+
status:
126+
- command -v gorelease
127+
cmds:
128+
- go install golang.org/x/exp/cmd/gorelease@latest
129+
130+
api:check:
131+
desc: Checks what changes have been made to the public API
132+
deps: [gorelease:install]
133+
vars:
134+
LATEST:
135+
sh: git describe --tags --abbrev=0
136+
cmds:
137+
- gorelease -base={{.LATEST}}
138+
123139
release:*:
124140
desc: Prepare the project for a new release
125141
summary: |

0 commit comments

Comments
 (0)