-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
[GH-189] ブランチルールのステータスチェックについてドキュメントを追加
- Loading branch information
Showing
3 changed files
with
32 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,20 @@ | ||
## Branch Rules | ||
# Branch | ||
|
||
Language: English | [日本語](/docs/ja/BRANCH.md) | ||
|
||
## Branch protection rule | ||
|
||
This section describes | ||
the [Branch protection rule](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule). | ||
|
||
### status check | ||
|
||
There is a status-check job in [check-pr.yaml](../../.github/workflows/check-pr.yaml). | ||
Since it aggregates the results of other check jobs, it is designed so that only the `status-check` | ||
job needs to be set | ||
as | ||
a status check target. | ||
|
||
Add `status-check` to `Status checks that are required` in `Require status checks to pass`. | ||
|
||
 |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,16 @@ | ||
## ブランチルール | ||
# ブランチ | ||
|
||
言語: 日本語 | [English](/docs/en/BRANCH.md) | ||
|
||
## ブランチ保護ルール | ||
|
||
[ブランチ保護ルール](https://docs.github.com/ja/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule) について記載します。 | ||
|
||
### ステータスチェック | ||
|
||
[check-pr.yaml](../../.github/workflows/check-pr.yaml) に `status-check` ジョブがあります。 | ||
他のチェックジョブの結果を集約しているため、ステータスチェック対象のジョブを `status-check` ジョブのみ設定するだけでよくなる設計です。 | ||
|
||
`Require status checks to pass` の `Status checks that are required` に `status-check` を追加します。 | ||
|
||
 |