DEPRECATION WARNING We now use the Watermelon Context App, please install that. This action will have no further development
Watermelon is your AI-Powered Code Review Toolbox. We improve the code review process by providing business logic context to GitHub PRs.
Our GitHub Action indexes the most relevant PR, Jira ticket, and Slack message thread for a new PR. This way, we help you make the code review process faster and in a more informed way.
Create a "watermelon.yml" file in ".github/workflows/". Then, copy and paste the following snippet into your .yml file
name: watermelon-context
on: [pull_request]
jobs:
getcontext:
runs-on: ubuntu-latest
name: Get code context with Watermelon
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Watermelon-context-action
uses: watermelontools/watermelon-context-action@main
with:
token: ${{ secrets.GITHUB_TOKEN }}
or copy and paste the following snippet into your .yml file
- name: Watermelon-context-action uses: watermelontools/watermelon-context-action@v1.0
After this, you can start by logging in. You will be asked to give us read access to your GitHub organization, and optionally, to your Jira and Slack teams.
You can find the roadmap for this product here.
The first feature for our alpha version is bringing the most relevant pieces of information from GitHub, Jira, and Slack for a new PR.
Soon, we will generate a GPT-powered summary of this indexed context.
Check out Contributing.md and be aware of the Code of Conduct!
We're an early stage project, therefore we still have the luxury to coordinate via short chats with our contributors. If you're interested in contributing, please join our Discord community. Alternatively, comment on our issues if you plan to solve one.
We are in the process of integrating VS Code's telemetry library. We're in the process of evaluating this alternative since we have a VS Code extension that complements this GitHub Action.
Watermelon is built by a globally distributed team of developers devoted to making software development easier. Join our Discord community, follow us on Twitter and go to the Watermelon blog to get the best programming tips.