/pull-request-assistant

A GitHub Action that represents an assistant in form of a CLI tool that you could use inside a GitHub Pull Request.

Primary LanguageJavaScriptApache License 2.0Apache-2.0

dev-tools

CI codecov

License

Pull Request Assistant (Friday 🤖)

🚀 Quick Start                   🔧 Configuration

📜 Documentation           📃 Commands

👷 For Developers


Pull Request Assistant is a GitHub Action which helps automate different routines that we're usually running on Pull Requests.

Using it, you can execute commands on your Pull Request exactly the same as in a terminal. The commands could be executed by simply adding them as a comment to the Pull Request.

At the moment, there is only one command that you can use - which is merge and which helps you merge the PRs easier. However, the project is based on commander, and it's very easy to add new commands. Thus feel free to report new issues and contribute to this awesome project.

p.s. you can set the name you like for the assistant however the default name is Friday. I consider it a continuation of https://github.com/maximbircu/friday :)

License

Copyright 2022 Maxim Bîrcu

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.