Quick Start Guide

Prerequisites

Before you begin, ensure you have:

  • A Docker container runner in your CI/CD environment
  • API tokens configured for platform authentication
  • Pull request or merge request workflows enabled in your repository

Integration Steps

  1. Generate API Key

    First, generate an API key from your Lintify dashboard. This key will be used to authenticate your CI/CD pipeline with Lintify services.

    Learn how to generate API key
  2. Choose Your Platform

    Select your CI/CD platform and follow the platform-specific integration guide:

  3. Configure Parameters

    Each platform requires specific parameters to be configured. The essential parameters include:

    • PLATFORM - Your platform name
    • API_TOKEN - Your Lintify API token
    • REPOSITORY - Your repository name
    • PULL_REQUEST_ID - Pull/Merge request identifier

Next Steps

After completing the basic setup, you can:

  • Configure advanced options for your specific needs
  • Set up custom rules and preferences
  • Integrate with your team's workflow

Need Help?

If you encounter any issues during setup, check our troubleshooting guide or contact support.