Ryujinx-Mako/README.md

95 lines
2.6 KiB
Markdown
Raw Normal View History

2023-08-19 19:27:50 +00:00
# Ryujinx-Mako
Create a new python package for the current scripts (#1) * infra: Add PR triage action (#5293) This is a bare minimal triage action that handle big categories. In the future we could also label all services correctly but I didn't felt this was required for a first iteration. * infra: Fix PR triage workflow glob patterns (#5297) * Use glob patterns to match file paths * Update ignored paths for releases * Adjust build.yml as well * Add names to auto-assign steps * Fix developer team name * Allow build workflows to run if workflows changed * Fix action version (#5299) * infra: Sync paths-ignore with release job and attempt to fix review assign * infra: Fix PR triage once and for all (#5442) Switch to a custom made python script that query GitHub API to grab latest state of the PR after label assign. * infra: Fix team name in reviewer.yml * infra: do not assign developers team for now Hopefully fix PR triage for real... * Introduce Mako to fix pr_triage workflow (#5574) * pr_triage: Fix invalid workflow * Don't assign reviewers to draft PRs * Add team review request for developers team * Introduce Mako to make team reviewers work * Convert app and installation ids to int (#5587) * infra: add missing quotes around @ developers in reviewers.yml * Adjust README.md and LICENSE * Remove unneeded workflow files * Add basic .editorconfig * Add basic requirements.txt * Add dependabot.yml * Add formatting workflow * Move update_reviewers.py into a new python module * Add reviewers.yml template * Replace requirements.txt with poetry * Fix typo * Add setup-mako action * Add constants to private module * Migrate update_reviewers to subcommand * Add NullHandler for root logger * Add setup-git subcommand * Group all subcommands * Add main script for ryujinx_mako * Create ryujinx-mako command * Add more information to README.md * Apply black formatting * Make PR author check case-insensitive --------- Co-authored-by: Mary <mary@mary.zone> Co-authored-by: ryujinx-mako[bot] <142357924+ryujinx-mako[bot]@users.noreply.github.com>
2023-08-30 17:00:29 +00:00
2023-08-19 19:27:50 +00:00
A custom GitHub App to aid Ryujinx with project management and moderation
Create a new python package for the current scripts (#1) * infra: Add PR triage action (#5293) This is a bare minimal triage action that handle big categories. In the future we could also label all services correctly but I didn't felt this was required for a first iteration. * infra: Fix PR triage workflow glob patterns (#5297) * Use glob patterns to match file paths * Update ignored paths for releases * Adjust build.yml as well * Add names to auto-assign steps * Fix developer team name * Allow build workflows to run if workflows changed * Fix action version (#5299) * infra: Sync paths-ignore with release job and attempt to fix review assign * infra: Fix PR triage once and for all (#5442) Switch to a custom made python script that query GitHub API to grab latest state of the PR after label assign. * infra: Fix team name in reviewer.yml * infra: do not assign developers team for now Hopefully fix PR triage for real... * Introduce Mako to fix pr_triage workflow (#5574) * pr_triage: Fix invalid workflow * Don't assign reviewers to draft PRs * Add team review request for developers team * Introduce Mako to make team reviewers work * Convert app and installation ids to int (#5587) * infra: add missing quotes around @ developers in reviewers.yml * Adjust README.md and LICENSE * Remove unneeded workflow files * Add basic .editorconfig * Add basic requirements.txt * Add dependabot.yml * Add formatting workflow * Move update_reviewers.py into a new python module * Add reviewers.yml template * Replace requirements.txt with poetry * Fix typo * Add setup-mako action * Add constants to private module * Migrate update_reviewers to subcommand * Add NullHandler for root logger * Add setup-git subcommand * Group all subcommands * Add main script for ryujinx_mako * Create ryujinx-mako command * Add more information to README.md * Apply black formatting * Make PR author check case-insensitive --------- Co-authored-by: Mary <mary@mary.zone> Co-authored-by: ryujinx-mako[bot] <142357924+ryujinx-mako[bot]@users.noreply.github.com>
2023-08-30 17:00:29 +00:00
## Usage
Add the following step to your workflow:
```yml
- name: Run Ryujinx-Mako
uses: Ryujinx/Ryujinx-Mako@master
with:
command: <Mako subcommand>
args: <subcommand args>
app_id: ${{ secrets.MAKO_APP_ID }}
private_key: ${{ secrets.MAKO_PRIVATE_KEY }}
installation_id: ${{ secrets.MAKO_INSTALLATION_ID }}
```
## Required environment variables
- `MAKO_APP_ID`: the GitHub App ID
- `MAKO_PRIVATE_KEY`: the contents of the GitHub App private key
- `MAKO_INSTALLATION_ID`: the GitHub App installation ID
Create a new python package for the current scripts (#1) * infra: Add PR triage action (#5293) This is a bare minimal triage action that handle big categories. In the future we could also label all services correctly but I didn't felt this was required for a first iteration. * infra: Fix PR triage workflow glob patterns (#5297) * Use glob patterns to match file paths * Update ignored paths for releases * Adjust build.yml as well * Add names to auto-assign steps * Fix developer team name * Allow build workflows to run if workflows changed * Fix action version (#5299) * infra: Sync paths-ignore with release job and attempt to fix review assign * infra: Fix PR triage once and for all (#5442) Switch to a custom made python script that query GitHub API to grab latest state of the PR after label assign. * infra: Fix team name in reviewer.yml * infra: do not assign developers team for now Hopefully fix PR triage for real... * Introduce Mako to fix pr_triage workflow (#5574) * pr_triage: Fix invalid workflow * Don't assign reviewers to draft PRs * Add team review request for developers team * Introduce Mako to make team reviewers work * Convert app and installation ids to int (#5587) * infra: add missing quotes around @ developers in reviewers.yml * Adjust README.md and LICENSE * Remove unneeded workflow files * Add basic .editorconfig * Add basic requirements.txt * Add dependabot.yml * Add formatting workflow * Move update_reviewers.py into a new python module * Add reviewers.yml template * Replace requirements.txt with poetry * Fix typo * Add setup-mako action * Add constants to private module * Migrate update_reviewers to subcommand * Add NullHandler for root logger * Add setup-git subcommand * Group all subcommands * Add main script for ryujinx_mako * Create ryujinx-mako command * Add more information to README.md * Apply black formatting * Make PR author check case-insensitive --------- Co-authored-by: Mary <mary@mary.zone> Co-authored-by: ryujinx-mako[bot] <142357924+ryujinx-mako[bot]@users.noreply.github.com>
2023-08-30 17:00:29 +00:00
## Available commands
```
usage: ryujinx_mako [-h] {setup-git,update-reviewers,exec-ryujinx-tasks} ...
Create a new python package for the current scripts (#1) * infra: Add PR triage action (#5293) This is a bare minimal triage action that handle big categories. In the future we could also label all services correctly but I didn't felt this was required for a first iteration. * infra: Fix PR triage workflow glob patterns (#5297) * Use glob patterns to match file paths * Update ignored paths for releases * Adjust build.yml as well * Add names to auto-assign steps * Fix developer team name * Allow build workflows to run if workflows changed * Fix action version (#5299) * infra: Sync paths-ignore with release job and attempt to fix review assign * infra: Fix PR triage once and for all (#5442) Switch to a custom made python script that query GitHub API to grab latest state of the PR after label assign. * infra: Fix team name in reviewer.yml * infra: do not assign developers team for now Hopefully fix PR triage for real... * Introduce Mako to fix pr_triage workflow (#5574) * pr_triage: Fix invalid workflow * Don't assign reviewers to draft PRs * Add team review request for developers team * Introduce Mako to make team reviewers work * Convert app and installation ids to int (#5587) * infra: add missing quotes around @ developers in reviewers.yml * Adjust README.md and LICENSE * Remove unneeded workflow files * Add basic .editorconfig * Add basic requirements.txt * Add dependabot.yml * Add formatting workflow * Move update_reviewers.py into a new python module * Add reviewers.yml template * Replace requirements.txt with poetry * Fix typo * Add setup-mako action * Add constants to private module * Migrate update_reviewers to subcommand * Add NullHandler for root logger * Add setup-git subcommand * Group all subcommands * Add main script for ryujinx_mako * Create ryujinx-mako command * Add more information to README.md * Apply black formatting * Make PR author check case-insensitive --------- Co-authored-by: Mary <mary@mary.zone> Co-authored-by: ryujinx-mako[bot] <142357924+ryujinx-mako[bot]@users.noreply.github.com>
2023-08-30 17:00:29 +00:00
A python module to aid Ryujinx with project management and moderation
options:
-h, --help show this help message and exit
subcommands:
{setup-git,update-reviewers,exec-ryujinx-tasks}
setup-git Configure git identity for Ryujinx-Mako
update-reviewers Update reviewers for the specified PR
exec-ryujinx-tasks Execute all Ryujinx tasks for a specific event
Create a new python package for the current scripts (#1) * infra: Add PR triage action (#5293) This is a bare minimal triage action that handle big categories. In the future we could also label all services correctly but I didn't felt this was required for a first iteration. * infra: Fix PR triage workflow glob patterns (#5297) * Use glob patterns to match file paths * Update ignored paths for releases * Adjust build.yml as well * Add names to auto-assign steps * Fix developer team name * Allow build workflows to run if workflows changed * Fix action version (#5299) * infra: Sync paths-ignore with release job and attempt to fix review assign * infra: Fix PR triage once and for all (#5442) Switch to a custom made python script that query GitHub API to grab latest state of the PR after label assign. * infra: Fix team name in reviewer.yml * infra: do not assign developers team for now Hopefully fix PR triage for real... * Introduce Mako to fix pr_triage workflow (#5574) * pr_triage: Fix invalid workflow * Don't assign reviewers to draft PRs * Add team review request for developers team * Introduce Mako to make team reviewers work * Convert app and installation ids to int (#5587) * infra: add missing quotes around @ developers in reviewers.yml * Adjust README.md and LICENSE * Remove unneeded workflow files * Add basic .editorconfig * Add basic requirements.txt * Add dependabot.yml * Add formatting workflow * Move update_reviewers.py into a new python module * Add reviewers.yml template * Replace requirements.txt with poetry * Fix typo * Add setup-mako action * Add constants to private module * Migrate update_reviewers to subcommand * Add NullHandler for root logger * Add setup-git subcommand * Group all subcommands * Add main script for ryujinx_mako * Create ryujinx-mako command * Add more information to README.md * Apply black formatting * Make PR author check case-insensitive --------- Co-authored-by: Mary <mary@mary.zone> Co-authored-by: ryujinx-mako[bot] <142357924+ryujinx-mako[bot]@users.noreply.github.com>
2023-08-30 17:00:29 +00:00
```
### setup-git
```
usage: ryujinx_mako setup-git [-h] [-l]
Configure git identity for Ryujinx-Mako
Create a new python package for the current scripts (#1) * infra: Add PR triage action (#5293) This is a bare minimal triage action that handle big categories. In the future we could also label all services correctly but I didn't felt this was required for a first iteration. * infra: Fix PR triage workflow glob patterns (#5297) * Use glob patterns to match file paths * Update ignored paths for releases * Adjust build.yml as well * Add names to auto-assign steps * Fix developer team name * Allow build workflows to run if workflows changed * Fix action version (#5299) * infra: Sync paths-ignore with release job and attempt to fix review assign * infra: Fix PR triage once and for all (#5442) Switch to a custom made python script that query GitHub API to grab latest state of the PR after label assign. * infra: Fix team name in reviewer.yml * infra: do not assign developers team for now Hopefully fix PR triage for real... * Introduce Mako to fix pr_triage workflow (#5574) * pr_triage: Fix invalid workflow * Don't assign reviewers to draft PRs * Add team review request for developers team * Introduce Mako to make team reviewers work * Convert app and installation ids to int (#5587) * infra: add missing quotes around @ developers in reviewers.yml * Adjust README.md and LICENSE * Remove unneeded workflow files * Add basic .editorconfig * Add basic requirements.txt * Add dependabot.yml * Add formatting workflow * Move update_reviewers.py into a new python module * Add reviewers.yml template * Replace requirements.txt with poetry * Fix typo * Add setup-mako action * Add constants to private module * Migrate update_reviewers to subcommand * Add NullHandler for root logger * Add setup-git subcommand * Group all subcommands * Add main script for ryujinx_mako * Create ryujinx-mako command * Add more information to README.md * Apply black formatting * Make PR author check case-insensitive --------- Co-authored-by: Mary <mary@mary.zone> Co-authored-by: ryujinx-mako[bot] <142357924+ryujinx-mako[bot]@users.noreply.github.com>
2023-08-30 17:00:29 +00:00
options:
-h, --help show this help message and exit
-l, --local configure the git identity only for the current repository
Create a new python package for the current scripts (#1) * infra: Add PR triage action (#5293) This is a bare minimal triage action that handle big categories. In the future we could also label all services correctly but I didn't felt this was required for a first iteration. * infra: Fix PR triage workflow glob patterns (#5297) * Use glob patterns to match file paths * Update ignored paths for releases * Adjust build.yml as well * Add names to auto-assign steps * Fix developer team name * Allow build workflows to run if workflows changed * Fix action version (#5299) * infra: Sync paths-ignore with release job and attempt to fix review assign * infra: Fix PR triage once and for all (#5442) Switch to a custom made python script that query GitHub API to grab latest state of the PR after label assign. * infra: Fix team name in reviewer.yml * infra: do not assign developers team for now Hopefully fix PR triage for real... * Introduce Mako to fix pr_triage workflow (#5574) * pr_triage: Fix invalid workflow * Don't assign reviewers to draft PRs * Add team review request for developers team * Introduce Mako to make team reviewers work * Convert app and installation ids to int (#5587) * infra: add missing quotes around @ developers in reviewers.yml * Adjust README.md and LICENSE * Remove unneeded workflow files * Add basic .editorconfig * Add basic requirements.txt * Add dependabot.yml * Add formatting workflow * Move update_reviewers.py into a new python module * Add reviewers.yml template * Replace requirements.txt with poetry * Fix typo * Add setup-mako action * Add constants to private module * Migrate update_reviewers to subcommand * Add NullHandler for root logger * Add setup-git subcommand * Group all subcommands * Add main script for ryujinx_mako * Create ryujinx-mako command * Add more information to README.md * Apply black formatting * Make PR author check case-insensitive --------- Co-authored-by: Mary <mary@mary.zone> Co-authored-by: ryujinx-mako[bot] <142357924+ryujinx-mako[bot]@users.noreply.github.com>
2023-08-30 17:00:29 +00:00
```
### update-reviewers
```
usage: ryujinx_mako update-reviewers [-h] repo_path pr_number config_path
Update reviewers for the specified PR
positional arguments:
repo_path full name of the GitHub repository (format: OWNER/REPO)
pr_number the number of the pull request to check
config_path the path to the reviewers config file
Create a new python package for the current scripts (#1) * infra: Add PR triage action (#5293) This is a bare minimal triage action that handle big categories. In the future we could also label all services correctly but I didn't felt this was required for a first iteration. * infra: Fix PR triage workflow glob patterns (#5297) * Use glob patterns to match file paths * Update ignored paths for releases * Adjust build.yml as well * Add names to auto-assign steps * Fix developer team name * Allow build workflows to run if workflows changed * Fix action version (#5299) * infra: Sync paths-ignore with release job and attempt to fix review assign * infra: Fix PR triage once and for all (#5442) Switch to a custom made python script that query GitHub API to grab latest state of the PR after label assign. * infra: Fix team name in reviewer.yml * infra: do not assign developers team for now Hopefully fix PR triage for real... * Introduce Mako to fix pr_triage workflow (#5574) * pr_triage: Fix invalid workflow * Don't assign reviewers to draft PRs * Add team review request for developers team * Introduce Mako to make team reviewers work * Convert app and installation ids to int (#5587) * infra: add missing quotes around @ developers in reviewers.yml * Adjust README.md and LICENSE * Remove unneeded workflow files * Add basic .editorconfig * Add basic requirements.txt * Add dependabot.yml * Add formatting workflow * Move update_reviewers.py into a new python module * Add reviewers.yml template * Replace requirements.txt with poetry * Fix typo * Add setup-mako action * Add constants to private module * Migrate update_reviewers to subcommand * Add NullHandler for root logger * Add setup-git subcommand * Group all subcommands * Add main script for ryujinx_mako * Create ryujinx-mako command * Add more information to README.md * Apply black formatting * Make PR author check case-insensitive --------- Co-authored-by: Mary <mary@mary.zone> Co-authored-by: ryujinx-mako[bot] <142357924+ryujinx-mako[bot]@users.noreply.github.com>
2023-08-30 17:00:29 +00:00
options:
-h, --help show this help message and exit
```
### exec-ryujinx-tasks
```
usage: ryujinx_mako exec-ryujinx-tasks [-h] --event-name EVENT_NAME
--event-path EVENT_PATH [-w WORKSPACE]
repo_path run_id
Execute all Ryujinx tasks for a specific event
positional arguments:
repo_path full name of the GitHub repository (format:
OWNER/REPO)
run_id The unique identifier of the workflow run
options:
-h, --help show this help message and exit
--event-name EVENT_NAME
the name of the event that triggered the workflow run
--event-path EVENT_PATH
the path to the file on the runner that contains the
full event webhook payload
-w WORKSPACE, --workspace WORKSPACE
the working directory on the runner
```