Ryujinx-Mako/README.md
TSRBerry 628d977de2
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 19:00:29 +02:00

75 lines
1.5 KiB
Markdown

# Ryujinx-Mako
A custom GitHub App to aid Ryujinx with project management and moderation
## Usage
1. Add the following steps to your workflow:
```yml
- name: Checkout Ryujinx-Mako
uses: actions/checkout@v3
with:
repository: Ryujinx/Ryujinx-Mako
ref: master
path: ".ryujinx-mako"
- name: Setup Ryujinx-Mako
uses: .ryujinx-mako/.github/actions/setup-mako
```
2. Execute the available commands like this:
```yml
- name: Setup git identity for Ryujinx-Mako
run: |
poetry -C .ryujinx-mako shell
# ryujinx-mako <command> [<args>]
# for example:
ryujinx-mako setup-git
```
## Available commands
```
usage: ryujinx_mako [-h] {setup-git,update-reviewers} ...
A python module to aid Ryujinx with project management and moderation
options:
-h, --help show this help message and exit
subcommands:
setup-git Set git identity to Ryujinx-Mako
update-reviewers Update reviewers for the specified PR
```
### setup-git
```
usage: ryujinx_mako setup-git [-h] [-l]
Set git identity to Ryujinx-Mako
options:
-h, --help show this help message and exit
-l, --local Set git identity only for the current repository.
```
### update-reviewers
```
usage: ryujinx_mako update-reviewers [-h] repo_path pr_number config_path
Update reviewers for the specified PR
positional arguments:
repo_path
pr_number
config_path
options:
-h, --help show this help message and exit
```