diff --git a/README.md b/README.md index 806c2b1d..cc2f8e07 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,44 @@ # github-webhook-server -A [FastAPI-based](https://fastapi.tiangolo.com) webhook server for managing GitHub repositories. It handles tasks such as repository setup, branch protection, and webhook configuration. +A [FastAPI-based](https://fastapi.tiangolo.com) webhook server for managing GitHub pull requests workflow. and manage repositories. + +## Overview + +The tool will manage the following: + +###### Repositories + +- Configure repositories setting +- Configure branch protection +- Set itself as webhook for the repository +- Add missing lables to the repository + +###### Pull requests + +- Add reviewers from OWNER file +- Manage pull requests labels +- Check when the pull request is ready to be merged +- Build container from Dockerfile when pull request is merged +- Build container from Dockerfile when new release is pushed +- Push new release to PyPI when new release is pushed +- Open an issue for each pull request +- Add pull request size label + +###### Available user actions + +- Mark pull request as WIP by comment /wip to the pull request, To remove it from the pull request comment /wip cancel to the pull request. +- Block merging of pull request by comment /hold, To un-block merging of pull request comment /hold cancel. +- Mark pull request as verified by comment /verified to the pull request, to un-verify comment /verified cancel to the pull request. + - verified label removed on each new commit push. +- Cherry pick a merged pull request comment /cherry-pick in the pull request. + - Multiple target branches can be cherry-picked, separated by spaces. (/cherry-pick branch1 branch2) + - Cherry-pick will be started when pull request is merged +- Build and push container image command /build-and-push-container in the pull request (tag will be the pull request number). + - You can add extra args to the Podman build command + - Example: /build-and-push-container --build-arg OPENSHIFT_PYTHON_WRAPPER_COMMIT= +- Add a label by comment use /