CI/CD

NeoIQ Localize provides a CI/CD integration to help you translate your application.

How it Works

The CI/CD workflow in NeoIQ Localize follows a structured process to automate translation updates in your application:

1. Action Initialization

• The workflow begins when the action is triggered
• Sets up the necessary Git configuration and credentials

2. NeoIQ Localize Engine Processing

• The NeoIQ Localize engine processes your application's content
• Handles the translation tasks using the configured settings

3. Change Detection

The system checks for any translation changes and follows one of two paths:

When Changes are Found:

• Changes are committed to the repository
• Changes are pushed to the specified branch
• A Pull Request (PR) is created

When No Changes are Found:

• The workflow completes without creating a PR

4. Pull Request Creation

When changes are detected, a Pull Request is created with:

PR Content:

• Clear title indicating translation updates
• Detailed description of changes
• Quality check confirmations
• Instructions for review
• Links to documentation and support

PR Description Includes:

• Summary of translation updates
• List of what changed (updated translations, terminology consistency)
• Next steps for reviewers
• Links to documentation and support resources

Workflow Diagram

                  ┌─────────────────────┐
                  │   Action Starts     │
                  └──────────┬──────────┘
                             │
                  ┌──────────▼──────────┐
                  │    Setup Git &      │
                  │    Credentials      │
                  └──────────┬──────────┘
                             │
┌─────────────────────────────────────────────────────────┐
│░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
│░░░░░░░░░░░░░░░░░░░░ NeoIQ Localize Engine ░░░░░░░░░░░░░░░░░░░░│
│░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░│
└─────────────────────────────────────────────────────────┘
                             │
                  ┌──────────▼──────────┐
                  │   Check Changes     │───────┐
                  └──────────┬──────────┘       │
                             │                  │
                             │ [Changes]        │ [No Changes]
                             │                  │
                  ┌──────────▼──────────┐       │
                  │   Commit & Push     │       │
                  └──────────┬──────────┘       │
                             │                  │
                  ┌──────────▼──────────┐       │
                  │    Create PR        │       │
                  └──────────┬──────────┘       │
                             │                  │
                  ┌──────────▼──────────┐       │
                  │        Done         │◄──────┘
                  └─────────────────────┘

The workflow is designed to be automated while still allowing for human review and quality control before changes are merged into your codebase. It maintains version control best practices and ensures that translations are properly tracked and documented through the Git history.