Skip to content

Commit 3d411a2

Browse files
Commit via running ake Sources/checks
1 parent bd1d9da commit 3d411a2

File tree

2 files changed

+64
-32
lines changed

2 files changed

+64
-32
lines changed

Sources/checks/Client.swift

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ public struct Client: APIProtocol {
4646
///
4747
/// In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
4848
///
49-
/// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
49+
/// > [!NOTE]
50+
/// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
5051
///
5152
/// - Remark: HTTP `POST /repos/{owner}/{repo}/check-runs`.
5253
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/post(checks/create)`.
@@ -122,7 +123,8 @@ public struct Client: APIProtocol {
122123
///
123124
/// Gets a single check run using its `id`.
124125
///
125-
/// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
126+
/// > [!NOTE]
127+
/// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
126128
///
127129
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
128130
///
@@ -192,7 +194,8 @@ public struct Client: APIProtocol {
192194
///
193195
/// Updates a check run for a specific commit in a repository.
194196
///
195-
/// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
197+
/// > [!NOTE]
198+
/// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
196199
///
197200
/// OAuth apps and personal access tokens (classic) cannot use this endpoint.
198201
///
@@ -497,7 +500,8 @@ public struct Client: APIProtocol {
497500
///
498501
/// Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)".
499502
///
500-
/// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
503+
/// > [!NOTE]
504+
/// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
501505
///
502506
/// OAuth apps and personal access tokens (classic) cannot use this endpoint.
503507
///
@@ -672,7 +676,8 @@ public struct Client: APIProtocol {
672676
///
673677
/// Gets a single check suite using its `id`.
674678
///
675-
/// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
679+
/// > [!NOTE]
680+
/// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
676681
///
677682
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
678683
///
@@ -742,7 +747,8 @@ public struct Client: APIProtocol {
742747
///
743748
/// Lists check runs for a check suite using its `id`.
744749
///
745-
/// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
750+
/// > [!NOTE]
751+
/// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
746752
///
747753
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
748754
///
@@ -923,7 +929,8 @@ public struct Client: APIProtocol {
923929
///
924930
/// Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.
925931
///
926-
/// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
932+
/// > [!NOTE]
933+
/// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
927934
///
928935
/// If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.
929936
///
@@ -1045,7 +1052,8 @@ public struct Client: APIProtocol {
10451052
///
10461053
/// Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.
10471054
///
1048-
/// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
1055+
/// > [!NOTE]
1056+
/// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
10491057
///
10501058
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
10511059
///

0 commit comments

Comments
 (0)