Skip to content

Commit

Permalink
📝Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
7rikazhexde committed Nov 5, 2024
1 parent e529c5f commit 821d8ba
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
18 changes: 9 additions & 9 deletions README-ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
## 機能

- [repository_dispatch](https://docs.github.com/ja/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#repository_dispatch) webhookイベントのトリガーはPythonコマンドとGitHub Actionsのアクションコンポーネントで実行できます。
- 複数の環境や、OSおよびPythonバージョンのカスタマイズをサポートします。(現状はバージョンはPythonのみサポート)
- `os``version`などのペイロードをサポートします。

> [!IMPORTANT]
> repository_dispatch イベントは mainブランチへのpushトリガーでは動作しますが、プルリクエストイベントではトリガーされない という仕様があります。プルリクエストイベントで repository_dispatch イベントを使用することはできませんので、注意が必要です。詳細については、[GitHubの公式ドキュメント](https://docs.github.com/ja/actions/writing-workflows/choosing-when-your-workflow-runs/triggering-a-workflow#triggering-a-workflow-from-a-workflow)をご確認ください。
Expand Down Expand Up @@ -75,14 +75,14 @@ pip install requirement.txt requirement-dev.txt
> [!NOTE]
> 事前に以下の**環境変数**を設定してください。
| 入力項目 | 説明 |Required|
|-------------------|--------------------------------------------------------------------------------|--------|
| `REPOSITORY_NAME` | 対象リポジトリの名前 (例: `yourusername/yourrepo`) | Yes |
| `EVENT_TYPE` | トリガーするイベントの種類 (例: `test_workflow`) | Yes |
| `OS_LIST` | ブラケット形式のカンマ区切りOS一覧 (例: '[ubuntu-latest,macos-13,windows-latest]') | Yes |
| `VERSION_LIST` | ブラケット形式のカンマ区切りPythonバージョン一覧 (例: Pythonの場合: '[3.11,3.12]') | Yes |
| `GHPAGES_BRANCH` | GitHub Pagesブランチ (デフォルトは `gh_pages`) | No |
| `CUSTOM_PARAM` | ペイロードのカスタムパラメータ(オプション) | No |
| 入力項目 | 説明 |Required|
|-------------------|--------------------------------------------------------|--------|
| `REPOSITORY_NAME` | 対象リポジトリの名前 (例: `yourusername/yourrepo`) | Yes |
| `EVENT_TYPE` | トリガーするイベントの種類 (例: `test_workflow`) | Yes |
| `OS_LIST` | OS一覧 (例: '[ubuntu-latest,macos-13,windows-latest]') | Yes |
| `VERSION_LIST` | バージョン一覧 (例: Pythonの場合: '[3.11,3.12,3.13]') | Yes |
| `GHPAGES_BRANCH` | GitHub Pagesブランチ (デフォルトは `gh_pages`) | No |
| `CUSTOM_PARAM` | ペイロードのカスタムパラメータ(オプション) | No |

#### 使用方法

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ English | [日本語](README-ja.md)
## Features

- Triggers [repository_dispatch](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#repository_dispatch) webhook events via Python commands and GitHub Actions components.
- Supports multiple environments with customization options for OS and Python versions. (Currently, only Python versions are supported.)
- Support payloads such as `os` and `version`.

> [!IMPORTANT]
> The repository_dispatch event works with push triggers to the main branch, but it does not trigger on pull request events. Therefore, please be aware that the repository_dispatch event cannot be used with pull request events. For more details, please refer to the [official GitHub documentation](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/triggering-a-workflow#triggering-a-workflow-from-a-workflow).
Expand Down Expand Up @@ -79,8 +79,8 @@ The project uses environment variables to create the payloads sent to the GitHub
|-------------------|--------------------------------------------------------------------------------------------|----------|
| `REPOSITORY_NAME` | The name of the target repository (e.g., 'yourusername/yourrepo') | Yes |
| `EVENT_TYPE` | The type of event to trigger (e.g., 'test_workflow') | Yes |
| `OS_LIST` | A comma-separated list of OS in brackets (e.g., '[ubuntu-latest,macos-13,windows-latest]') | Yes |
| `VERSION_LIST` | A comma-separated list of versions in brackets (e.g., for Python: '[3.11,3.12]') | Yes |
| `OS_LIST` | A comma-separated list of OS in brackets (e.g., '[ubuntu-latest,macos-13,windows-latest]') | Yes |
| `VERSION_LIST` | A comma-separated list of versions in brackets (e.g., for Python: '[3.11,3.12,3.13]') | Yes |
| `GHPAGES_BRANCH` | The GitHub Pages branch (default is 'gh_pages') | No |
| `CUSTOM_PARAM` | Custom parameters for the payload (optional) | No |

Expand Down

0 comments on commit 821d8ba

Please sign in to comment.