xibitdigital/xbt-ai-gitlab-plugin repository overview

⁠XBT-ai-gitlab-plugin

This a container to use the Gilab AI Service plugin.

⁠Running the Container

To run the container and execute the script, use the following command:

docker run --rm \
  -e API_KEY=${API_KEY} \
  -e API_URL=${API_URL} \
  -e ACTION=${ACTION} \
  -e STEPS_TO_ANALYZE=${STEPS_TO_ANALYZE} \
  -e CI_COMMIT_REF_NAME=${CI_COMMIT_REF_NAME} \
  -e CI_PROJECT_ID=${CI_PROJECT_ID} \
  -e CI_PIPELINE_ID=${CI_PIPELINE_ID} \
  -e CI_COMMIT_SHA=${CI_COMMIT_SHA} \
  -e LANGUAGE_FOCUS=${LANGUAGE_FOCUS} \
  xibitdigital/xbt-ai-gitlab-plugin:v.1.2.2

Replace the values after each -e flag with your actual data. Here's what each environment variable means:

• API_KEY: Your API key for authentication
• API_URL: The URL of the API you're interacting with (use this for beta testers only)
• ACTION: The action to be performed (as required by your API)
• STEPS_TO_ANALYZE: The name of the previous job step (comma separated Ex: plan_dev,deploy_dev)
• CI_COMMIT_REF_NAME: The name of the Git branch
• CI_PROJECT_ID: The ID of your project
• CI_PIPELINE_ID: The ID of the current pipeline
• CI_COMMIT_SHA: The SHA of the commit
• LANGUAGE_FOCUS: (Optional) Specifies languages or area to focus on during analysis or review. Leave empty if not applicable.

⁠Supported Languages and Extensions

The following languages and their associated file extensions are supported by the script:

• Python: .py, .pyc, .pyo, .pyd, .pyw, .pyz, .pyx, .pxd, .pxi, .pyp
• C: .c, .h, .o, .a, .so
• C++: .cpp, .hpp, .cc, .cxx, .hxx, .hh, .o, .a, .so
• Java: .java, .class, .jar
• JavaScript: .js, .mjs, .cjs, .jsx
• TypeScript: .ts, .tsx
• HTML: .html, .htm
• CSS: .css, .scss, .sass, .less
• Ruby: .rb, .erb, .rake, .gemspec
• PHP: .php, .php3, .php4, .php5, .phtml
• Swift: .swift
• Go: .go
• Kotlin: .kt, .kts
• Rust: .rs, .rlib
• Markdown: .md, .markdown
• YAML: .yaml, .yml
• Terraform: .tf, .tf.json, .hcl
• Terragrunt: .hcl, .hcl.json

⁠Troubleshooting

If you encounter any issues:

1. Ensure all required environment variables are correctly set
2. Verify that you have the necessary permissions to interact with the API
3. If the script fails, check the error message for clues about what went wrong

For any persistent issues, please contact [email protected]⁠