@slates-integrations/github 0.2.4 → 0.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -0
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/docs/SPEC.md +12 -4
- package/package.json +1 -1
package/docs/SPEC.md
CHANGED
|
@@ -8,10 +8,11 @@ GitHub is a cloud-based platform for version control and collaboration using Git
|
|
|
8
8
|
|
|
9
9
|
- `create_repository` creates a repository in the authenticated user's account unless
|
|
10
10
|
`organization` is provided. `private` defaults to `true`; pass `false` explicitly to
|
|
11
|
-
create a public repository. `autoInit` initializes the repository with a README
|
|
11
|
+
create a public repository. `autoInit` initializes the repository with a README, and
|
|
12
|
+
`gitignoreTemplate` / `licenseTemplate` apply GitHub's .gitignore and license templates.
|
|
12
13
|
- `merge_pull_request` accepts the optional snake-case fields `commit_title`,
|
|
13
|
-
`commit_message`, and `
|
|
14
|
-
and `rebase
|
|
14
|
+
`commit_message`, `merge_method`, and `sha`. Supported merge methods are `merge`,
|
|
15
|
+
`squash`, and `rebase`; `sha` makes GitHub refuse the merge if the head has moved.
|
|
15
16
|
- `list_issues` uses GraphQL cursor pagination. Pass `pageInfo.endCursor` from one
|
|
16
17
|
response as `after` to fetch the next page. `state` accepts `OPEN` or `CLOSED` and
|
|
17
18
|
returns both states when omitted. Labels are supplied as an array. Custom issue
|
|
@@ -30,7 +31,14 @@ GitHub is a cloud-based platform for version control and collaboration using Git
|
|
|
30
31
|
- `search` covers organizations through GitHub's user-search endpoint: use type
|
|
31
32
|
`users` with the `type:org` qualifier.
|
|
32
33
|
- `create_branch` creates a branch from `from_branch`, or from the repository's
|
|
33
|
-
default branch when the source is omitted.
|
|
34
|
+
default branch when the source is omitted. `delete_branch` deletes a branch ref,
|
|
35
|
+
such as a merged pull request's head branch; GitHub rejects deleting the default
|
|
36
|
+
branch and protected branches.
|
|
37
|
+
- `list_milestones` lists repository milestones with the `milestoneNumber` values
|
|
38
|
+
`manage_issue` accepts as `milestone`.
|
|
39
|
+
- REST page-based list tools (`list_pull_requests`, `list_branches`, `list_commits`,
|
|
40
|
+
`list_repositories`, `list_milestones`) report `hasNextPage` from GitHub's `Link`
|
|
41
|
+
header; request `page + 1` to continue.
|
|
34
42
|
- `push_files` writes multiple plain-text files atomically in one commit through the
|
|
35
43
|
Git tree, commit, and ref APIs. If the requested branch is absent, it is created
|
|
36
44
|
from the default branch.
|