Skip to content

Commit

Permalink
Merge pull request #9 from mhdzumair/develop
Browse files Browse the repository at this point in the history
Update plugin name due to gitlab legal policy
  • Loading branch information
mhdzumair authored Jun 16, 2023
2 parents d8130ad + b978d90 commit 728cc1f
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 31 deletions.
55 changes: 28 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,36 @@ GitAIOps is a ChatGPT plugin that enables ChatGPT to interact with Git services,

The GitAIOps plugins are currently submitted for review in the ChatGPT plugin store and can be used by up to 15 plugin developers for testing. Please note that these are unverified plugins. Here are the links to the deployed plugins:

- GitAIOps GitLab: [https://gitaiops.onrender.com](https://gitaiops.onrender.com)
- GitAIOps: [https://gitaiops.onrender.com](https://gitaiops.onrender.com)
- GitAIOps GitHub: [https://gitaiops-github.onrender.com](https://gitaiops-github.onrender.com)

## Usage

GitAIOps is designed to be used with ChatGPT. Once the plugin is installed, you can ask ChatGPT to perform actions on Git services. Here are some of the things you can do:
- Ability review merge requests
- provide feedback security.
- provide feedback code optimization.
- provide unit test cases.
- Debugging pipeline error (experimental support for scrubbing sensitive data. see [scrub_log function](https://github.com/mhdzumair/GitAIOps/blob/main/utils/log_scrubber.py#L26)).
- Update merge request descriptions.
- And much more! (Basically whatever thing that can do with APIs)

Please note that using this plugin requires a basic understanding of the GitLab and GitHub APIs. Also, be aware that the plugin interacts with data from your Git services, and it's your responsibility to ensure that this data does not contain sensitive information.

## Example Prompt
> - "I have created a merge request [mr link]. Write a code review for it, focusing on best practices such as code maintainability, security vulnerability and performance."
> - "Can you identify the problem in the job link [job link] and provide a detailed explanation of what went wrong and how it can be fixed?"
> - "Please modify the title and description of the merge request based on the modifications made in the merge request located at the following URL: [mr link]"
You can find conversations screenshots in the [example](artifacts/example) folder.


## Supported Git Services

- GitLab
- GitHub
- More to come!


## Local Installation

Expand Down Expand Up @@ -46,32 +73,6 @@ Now, you can specify the plugin URL as "localhost:8000" in your ChatGPT settings

You also need to store the API tokens for GitLab (`GITLAB_TOKEN`) and GitHub (`GITHUB_TOKEN`) in your environment variables. These tokens allow GitAIOps to authenticate with the Git services and perform actions.

## Usage

GitAIOps is designed to be used with ChatGPT. Once the plugin is installed, you can ask ChatGPT to perform actions on Git services. Here are some of the things you can do:
- Ability review merge requests
- provide feedback security.
- provide feedback code optimization.
- provide unit test cases.
- Debugging pipeline error (experimental support for scrubbing sensitive data. see [scrub_log function](https://github.com/mhdzumair/GitAIOps/blob/main/utils/log_scrubber.py#L26)).
- Update merge request descriptions.
- And much more! (Basically whatever thing that can do with APIs)

Please note that using this plugin requires a basic understanding of the GitLab and GitHub APIs. Also, be aware that the plugin interacts with data from your Git services, and it's your responsibility to ensure that this data does not contain sensitive information.
## Example Prompt
> - "I have created a merge request [mr link]. Write a code review for it, focusing on best practices such as code maintainability, security vulnerability and performance."
> - "Can you identify the problem in the job link [job link] and provide a detailed explanation of what went wrong and how it can be fixed?"
> - "Please modify the title and description of the merge request based on the modifications made in the merge request located at the following URL: [mr link]"
You can find conversations screenshots in the [example](artifacts/example) folder.
## Supported Git Services
- GitLab
- GitHub
- More to come!

## Security and Compliance

Expand Down
8 changes: 4 additions & 4 deletions artifacts/.well-known/ai-plugin-gitlab.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"schema_version": "v1",
"name_for_human": "GitAIOps GitLab",
"name_for_model": "gitaiops_gitlab",
"description_for_human": "Unofficial tool for GitLab CI/CD workflows. Enhances productivity.",
"description_for_model": "GitAIOps GitLab is an unofficial solution that enables interaction with GitLab CI/CD workflows. It can be used to review merge requests, debug pipeline errors, update merge request descriptions, and more.",
"name_for_human": "GitAIOps",
"name_for_model": "gitaiops",
"description_for_human": "Unofficial tool for GitLab CI/CD workflows. Streamlines merge request reviews, pipeline debugging, and more.",
"description_for_model": "GitAIOps is an unofficial solution that enables interaction with GitLab CI/CD workflows. It can be used to review merge requests, debug pipeline errors, update merge request descriptions, and more.",
"auth": {
"type": "oauth",
"client_url": "https://gitlab.com/oauth/authorize",
Expand Down

0 comments on commit 728cc1f

Please sign in to comment.