Skip to content

Commit

Permalink
Merge pull request #236 from yumemi-inc/improve/GH-189
Browse files Browse the repository at this point in the history
[GH-189] ブランチルールのステータスチェックについてドキュメントを追加
  • Loading branch information
tatsutakein committed Jun 5, 2024
2 parents f6c0582 + 1edeb25 commit 86c957f
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 2 deletions.
19 changes: 18 additions & 1 deletion docs/en/BRANCH.md
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`.

![branch-rules-status-check.png](../images/branch-rules-status-check.png)
Binary file added docs/images/branch-rules-status-check.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 14 additions & 1 deletion docs/ja/BRANCH.md
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` を追加します。

![branch-rules-status-check.png](../images/branch-rules-status-check.png)

0 comments on commit 86c957f

Please sign in to comment.