shanec/forgejo-sdk
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions
forgejo-sdk/docs/migrate-v0.15-to-v0.16.md

29 lines
1.3 KiB
Markdown
Raw Normal View History

GetPullRequestDiff: add PullRequestDiffOptions param (#542) this is for the upstream change in https://github.com/go-gitea/gitea/pull/17158 Co-authored-by: Norwin <git@nroo.de> Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/542 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Reviewed-by: 6543 <6543@obermui.de> Co-authored-by: Norwin <noerw@noreply.gitea.io> Co-committed-by: Norwin <noerw@noreply.gitea.io>
2022-01-13 17:30:39 +00:00
# Migration Guide: v0.15 to v0.16
v0.16.0 introduces a number of API changes, which should be simple to migrate.
Just follow this guide and if you still encounter problems, ask for help on Discord or feel free to create an issue.
<!-- toc -->
- [Upstream API changes](#upstream-api-changes)
- [GetPullRequestDiff: add PullRequestDiffOption parameter (#542)](#getpullrequestdiff)
<!-- tocstop -->
## Upstream API changes
As we aim to track API changes in Gitea 1.16 with this SDK release, you may find this [summary listing of changes](https://gitea.com/gitea/go-sdk/issues/558) helpful.
## GetPullRequestDiff
Added new parameter `opts PullRequestDiffOption`. Gitea 1.16 will default to omit binary file changes in diffs; if you still need that information, set `opts.Binary = true`.
Related PRs:
- [go-sdk#542](https://gitea.com/gitea/go-sdk/pulls/542)
- [gitea#17158](https://github.com/go-gitea/gitea/pull/17158)
Add response to `ReadRepoNotifications` (#590) - This is a breaking change. - Return the relevant notifications when the Gitea server is 1.16.0 or higher. - Ref: https://github.com/go-gitea/gitea/pull/17064 - Resolves #543 Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/590 Reviewed-by: 6543 <6543@obermui.de> Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: Gusted <williamzijl7@hotmail.com> Co-committed-by: Gusted <williamzijl7@hotmail.com>
2022-05-15 16:47:38 +01:00
## ReadNotification, ReadNotifications, ReadRepoNotifications
The function now has a new return argument. The read notifications will now be returned by Gitea 1.16. If you don't require this information, use a blank identifier for the return variable.
Related PRs:
- [go-sdk#590](https://gitea.com/gitea/go-sdk/pulls/590)
- [gitea#17064](https://github.com/go-gitea/gitea/pull/17064)
Reference in a new issue Copy permalink