@gitkraken/provider-apis 0.17.5 → 0.18.1

package/CHANGELOG.md

@@ -1,5 +1,172 @@
 # Changelog
 
+## 0.18.1
+
+- reverted inclusion of local test config
+
+## 0.18.0
+
+### ⚠️ Breaking Changes
+
+This version refactors all of the mutation functions for all providers. The mutation functions are now standardized to take `GitPullRequest` or `Issue` objects as arguments, which differs from the lack of standardization present in earlier verisons.
+
+Examples of how to call the new functions:
+
+```ts
+const pullRequest: GitPullRequest = { /* ... some PR object from your app's state ... */ };
+
+// pre-v0.18.0 way of merging a pull request for gitlab
+await gitlab.mergePullRequest({
+  repo: {
+    namespace: pullRequest.repository.owner.login!,
+    name: pullRequest.repository.name,
+  },
+  pullRequestId: pullRequest.number, // other providers might use the `graphQLId` or `id` fields
+  expectedSourceSha: pullRequest.headRef.oid!, // other providers might not need this at all
+  mergeStrategy: GitMergeStrategy.Squash, // or `undefined` to use the repo's default merge strategy
+});
+
+// v0.18.0 way of merging a pull request for gitlab
+await gitlab.mergePullRequest({
+  pullRequest,
+  mergeStrategy: GitMergeStrategy.Squash, // or `undefined` to use the repo's default merge strategy
+});
+```
+
+```ts
+const issue: Issue = { /* ... some issue object from your app's state ... */ };
+const labels: GitLabel[] = [{ /* ... some label objects from your app's state ... */ }];
+
+// pre-v0.18.0 way of setting issue labels for gitlab
+await gitlab.setIssueLabels({
+  repo: {
+    namespace: issue.repository.owner.login!,
+    name: issue.repository.name,
+  },
+  issueId: issue.number, // other providers might use the `graphQLId` or `id` fields
+  labelGraphQLIds: labels.map((label) => label.graphQLId),
+});
+
+// v0.18.0 way of setting issue labels
+await gitlab.setIssueLabels({
+  issue,
+  labels,
+});
+```
+
+The new functions take various `Set*Input` interfaces as arguments.
+
+```ts
+interface GitProvider {
+  // ...
+  setPullRequestMilestone?(
+    input: {
+      pullRequest: SetPullRequestInput;
+      milestone: SetMilestoneInput | null;
+    },
+    options: Options
+  ): Promise<void>;
+  // ...
+}
+```
+
+The `Set*Input` interfaces are designed to take their corresponding provider library object. `SetPullRequestInput` is designed to take a `GitPullRequest` object. `SetMilestoneInput` is designed to take a `GitMilestone` object. Here's a quick reference of the various `Set*Input` interfaces and the objects that they are designed to take:
+
+|`Set*Input` interface|Provider library object                    |
+|---------------------|-------------------------------------------|
+|SetPullRequestInput  |GitPullRequest                             |
+|SetIssueInput        |Issue                                      |
+|SetMilestoneInput    |GitMilestone                               |
+|SetAccountInput      |Account                                    |
+|SetLabelInput        |GitLabel                                   |
+|SetStatusInput       |IssueTransition, TrelloBoard, WorkItemState|
+
+Now, wih all of that explained, here's the list of updated mutation functions:
+
+Azure Dev Ops:
+- closePullRequest
+- mergePullRequest
+- addPullRequestLabel
+- removePullRequestLabel
+- setPullRequestAsDraft
+- addPullRequestReviewer
+- removePullRequestReviewer
+- setIssueStatus
+- setIssueAssignee
+- setIssueLabels
+
+- setPullRequestReviewers **(new)**
+- setPullRequestLabels **(new)**
+
+Bitbucket:
+- closePullRequest
+- mergePullRequest
+- setPullRequestReviewers
+
+Bitbucket Server:
+- closePullRequest
+- mergePullRequest
+- setPullRequestReviewers
+
+GitHub/GitHub Enterprise:
+- closePullRequest
+- mergePullRequest
+- setPullRequestMilestone
+- setPullRequestAsDraft
+- setPullRequestReviewers
+- setPullRequestAssignees
+- setPullRequestLabels
+- setIssueLabels
+- setIssueMilestone
+- setIssueAssignees
+
+- reOpenIssue **(new)**
+- closeIssue **(new)**
+- closeIssueWithReason **(new)**
+- reRequestPullRequestReviews **(new)**
+
+- setIssueStatus was **removed**
+
+GitLab/GitLab Self-Managed:
+- closePullRequest
+- mergePullRequest
+- setPullRequestMilestone
+- setPullRequestAsDraft
+- setPullRequestReviewers
+- setPullRequestAssignees
+- setPullRequestLabels
+- setIssueLabels
+- setIssueMilestone
+- setIssueAssignees
+
+- closeIssue **(new)**
+- reOpenIssue **(new)**
+- reRequestPullRequestReview **(new)**
+- reRequestPullRequestReviews **(new)**
+
+- setIssueStatus was **removed**
+
+Jira:
+- setIssueStatus
+- setIssueAssignee
+- setIssueComponents
+- setIssueLabels
+
+Jira Server:
+- setIssueStatus
+- setIssueComponents
+- setIssueLabels
+
+Trello:
+- setIssueStatus
+- setIssueAssignees
+- setIssueLabels
+
+- archiveIssue **(new)**
+- unArchiveIssue **(new)**
+
+- setIssueArchived was **removed**
+
 ## 0.17.5
 
 - added `getIssue` (Jira Cloud and Jira Server)