How jetbrains/qodana-action works
Main Components Identification
a) Core Components:
• Qodana Plugin (Kotlin-based)
• Scan Module (TypeScript-based)
• CI/CD Integration Modules:
• GitHub Actions
• Azure DevOps (VSTS)
• CircleCI Orb
b) External Services:
• GitHub API
• Qodana Cloud
• CI/CD Platforms
┌─ CI/CD Layer ─────────────────────────────┐
• GitHub Actions │ Azure DevOps │ CircleCI │
• ┘
• ↓ ↓ ↓
┌─ Core Layer ──────────────────────────────┐
• ┌─ Qodana Action ─┐ │
• Scan Module │ ←→ Qodana Plugin │
• (TypeScript) │ (Kotlin) │
• ┘ │
• ┘
• ↕ ↕ ↕
┌─ External Services Layer ─────────────────┐
• GitHub API │ Qodana Cloud │ Storage │
• ┘
Component Details
For each component, include:
a) Qodana Plugin:
• Input: Project source code
• Output: SARIF reports
• Configuration: qodana.yaml
b) Scan Module:
• Functionality: Code analysis
• Integration: CI/CD platforms
• Results processing
c) CI/CD Integrations:
• Configuration options
• Authentication flows
• Results reporting
Data Flow Representation
Following flows:
• Source code → Qodana Scanner
• Scanner → SARIF output
• SARIF → CI/CD platforms
• Results → Qodana Cloud
• Annotations → GitHub/Azure DevOps
Important Details
• Quality Gate workflow
• Baseline processing
• Quick-fixes application flow
• Cache management
• Results upload paths
The various integration points with external services
This system design should help developers understand both the high-level architecture and the specific implementation details of the Qodana Scan project.