You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hi @ellipsis-dev - can you create the Dockerfile you need to test your code? And an ellipsis.yaml file - an example below:
version: 1.3
about:
- "This is a codebase for a code generation tool called Ellipsis. It can review GitHub pull requests, answer questions about code, and even generate bug fixes!"
- "We're migrating away from using AWS CDK. Our infrastructure is no longer part of this repository."
build:
file: "ellipsis.Dockerfile"
commands:
- name: "lint_fix"
description: "Lints the code in fix mode, which will fix some errors, format some files, and throw and error when there are violations."
command: "./scripts/lint.sh"
- name: "unit_tests"
description: "Runs the unit tests."
command: ./scripts/unit_test.sh
pr_review:
confidence_threshold: 0.7
rules:
- "Code should be DRY (Dont Repeat Yourself)"
- "There should no secrets or credentials in the code"
- "Extremely Complicated Code Needs Comments"
- "Use Descriptive Variable and Constant Names"
- "API routes must have error handling, they shouldn't intentionally return a HTTP 500"
- "Use retries when calling external API services"
- "Don't log sensitive data"
- "Follow the Single Responsibility Principle"
- "Function and Method Naming Should Follow Consistent Patterns"
This repo carries a python package in sunholo/ - you can see the dependencies etc in /.setup.py
instructions below for the dockerfile:
⚠️ A Dockerfile is not required to use Ellipsis, but will increase the quality of code generation tasks. Dockerfiles are unused for code reviews.
Improving the quality of Ellipsis' code generation takes 5 minutes:
Add a Dockerfile to your repository:
The file should install the dependencies and copy your code into the container. We build this from the root of the repository.
The Dockerfile needs to include the [Git CLI](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
Do not include an ENTRYPOINT or CMD.
Update your ellipsis.yaml to point to this file by adding file which is under build (see below)
Add commands to your config file:
Commands are executed from the root of the repository and can lint, build, and even run your tests.
See the below example.
Upload dev environment variables:
Open the [console](https://app.ellipsis.dev/) and select your repository from the drop down.
Note: Only required if your project needs environment variables to run the commands.
Here's what (part of) your ellipsis.yaml might look like after these changes:
version: 1.3
build:
file: "ellipsis.Dockerfile"
commands:
- name: "lint_fix"
description: "Lints the code in fix mode, which will fix some errors, format some files, and throw and error when there are violations."
command: "./scripts/lint.sh"
- name: "unit_tests"
description: "Runs the unit tests."
command: ./scripts/unit_test.sh
The text was updated successfully, but these errors were encountered:
Hi @ellipsis-dev - can you create the Dockerfile you need to test your code? And an ellipsis.yaml file - an example below:
This repo carries a python package in sunholo/ - you can see the dependencies etc in /.setup.py
instructions below for the dockerfile:
The text was updated successfully, but these errors were encountered: