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

47 lines
1.5 KiB
Markdown
Raw Normal View History

Remove & Rename TrackedTimes list functions (#467) Start Migration Guide rm GetUserTrackedTimes() add options to GetRepoTrackedTimes Dedub Code & total refactor rename ListTrackedTimes -> ListIssueTrackedTimes add jsonHeader on all tt func Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/467 Reviewed-by: Norwin <noerw@noreply.gitea.io> Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Co-Authored-By: 6543 <6543@obermui.de> Co-Committed-By: 6543 <6543@obermui.de>
2020-12-17 10:03:47 +00:00
# Migration Guide: v0.13 to v0.14
Introduce NotifySubjectState (#520) close #515 Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/520 Reviewed-by: Andrew Thornton <art27@cantab.net> Reviewed-by: techknowlogick <techknowlogick@gitea.io> Co-authored-by: 6543 <6543@obermui.de> Co-committed-by: 6543 <6543@obermui.de>
2021-06-30 22:06:50 +01:00
v0.14.0 introduces a number of breaking changes, through which it should not be difficult to migrate.
Just follow this guid and if you still encounter problems, ask for help on discord or feel free to create an issue.
Remove & Rename TrackedTimes list functions (#467) Start Migration Guide rm GetUserTrackedTimes() add options to GetRepoTrackedTimes Dedub Code & total refactor rename ListTrackedTimes -> ListIssueTrackedTimes add jsonHeader on all tt func Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/467 Reviewed-by: Norwin <noerw@noreply.gitea.io> Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Co-Authored-By: 6543 <6543@obermui.de> Co-Committed-By: 6543 <6543@obermui.de>
2020-12-17 10:03:47 +00:00
<!-- toc -->
Update Structs (#486) * FileOptions: add Signoff * Commit: add CommitAffectedFiles * BranchProtection, CreateBranchProtectionOption, EditBranchProtectionOption: add BlockOnOfficialReviewRequests * MigrateRepoOption: add MirrorInterval & enable gogs as source option * EditRepoOption: Add new fields * Repository: Add new fields & related structs * PullReview: Add fields * StopWatch: Add new fields * EditIssueOption: Add option to delete Deadline * EditUserOption: lot of options got optional close #479 Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/486 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Reviewed-by: Andrew Thornton <art27@cantab.net> Co-authored-by: 6543 <6543@obermui.de> Co-committed-by: 6543 <6543@obermui.de>
2021-02-13 19:24:00 +00:00
- [Removed Functions (#467)](#removed-functions)
- [Renamed Functions (#467)](#renamed-functions)
- [New Optional Fields (#486)](#new-optional-fields)
UrlEscape Function Arguments used in UrlPath (#273) close #271 * [x] add check if user/repo-name is empty * [x] use net/url for links to encode Co-authored-by: Andrew Thornton <art27@cantab.net> Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/273 Reviewed-by: Andrew Thornton <art27@cantab.net> Reviewed-by: techknowlogick <techknowlogick@gitea.io> Co-authored-by: 6543 <6543@obermui.de> Co-committed-by: 6543 <6543@obermui.de>
2021-03-21 20:20:32 +00:00
- [Arguemnts are escapted by the SDK iteslve now (#273)](#escape-function-arguments)
Remove & Rename TrackedTimes list functions (#467) Start Migration Guide rm GetUserTrackedTimes() add options to GetRepoTrackedTimes Dedub Code & total refactor rename ListTrackedTimes -> ListIssueTrackedTimes add jsonHeader on all tt func Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/467 Reviewed-by: Norwin <noerw@noreply.gitea.io> Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Co-Authored-By: 6543 <6543@obermui.de> Co-Committed-By: 6543 <6543@obermui.de>
2020-12-17 10:03:47 +00:00
<!-- tocstop -->
## Removed Functions
- for **GetUserTrackedTimes** and **GetRepoTrackedTimes** use **ListRepoTrackedTimes** with specific options set
Pulls:
- [#467 Remove GetUserTrackedTimes](https://gitea.com/gitea/go-sdk/pulls/467)
## Renamed Functions
- **ListTrackedTimes** is now **ListIssueTrackedTimes**
Pulls:
- [#467 Remove & Rename TrackedTimes list functions](https://gitea.com/gitea/go-sdk/pulls/467)
Update Structs (#486) * FileOptions: add Signoff * Commit: add CommitAffectedFiles * BranchProtection, CreateBranchProtectionOption, EditBranchProtectionOption: add BlockOnOfficialReviewRequests * MigrateRepoOption: add MirrorInterval & enable gogs as source option * EditRepoOption: Add new fields * Repository: Add new fields & related structs * PullReview: Add fields * StopWatch: Add new fields * EditIssueOption: Add option to delete Deadline * EditUserOption: lot of options got optional close #479 Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/486 Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com> Reviewed-by: Andrew Thornton <art27@cantab.net> Co-authored-by: 6543 <6543@obermui.de> Co-committed-by: 6543 <6543@obermui.de>
2021-02-13 19:24:00 +00:00
## New Optional Fields
The `EditUserOption` struct has gained several new Optional fields.
For example Email type changed from `string` to `*string`.
The easiest migration path is, to wrap your options with:
**OptionalString()**, **OptionalBool()** and **OptionalInt64()**
Pulls:
- [#486 Update Structs](https://gitea.com/gitea/go-sdk/pulls/486)
UrlEscape Function Arguments used in UrlPath (#273) close #271 * [x] add check if user/repo-name is empty * [x] use net/url for links to encode Co-authored-by: Andrew Thornton <art27@cantab.net> Reviewed-on: https://gitea.com/gitea/go-sdk/pulls/273 Reviewed-by: Andrew Thornton <art27@cantab.net> Reviewed-by: techknowlogick <techknowlogick@gitea.io> Co-authored-by: 6543 <6543@obermui.de> Co-committed-by: 6543 <6543@obermui.de>
2021-03-21 20:20:32 +00:00
## Escape Function Arguments
String arguments like `user`, `repo`, `tag`, ... are now url/path/query escapted as they need.
If you had issues and did escape arguments by yourselve you have to remove this now.
Reference in a new issue Copy permalink