Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GH-189] ブランチルールのステータスチェックについてドキュメントを追加 #236

Merged
merged 2 commits into from
Jun 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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)