PingCAP CI/CD Public Configurations

Welcome to the CI documentation! Here you'll find comprehensive guides and references for using this project to manage CI pipeline for your project. This repository maintains CI/CD configurations for repositories under PingCAP, TiKV and other related organizations. It contains both trigger configurations and detailed pipeline implementations.

Table of Contents

• Core Concepts

  • Servers
  • CI Job Components
  • Design Principles

• matrixCache

  • Background and design
  • Implementation and usage
  • Effect examples

• Designs

  • Folder Structure
  • File Structure and Naming Conventions

• Guides

  • Finding Pipelines for a Specific Repository
  • How to Modify and Test a Pipeline
  • Job and Pipeline Change Governance — lifecycle, three-layer consistency and review checklist
  • Branch Support and EOL Governance — adding, syncing and retiring release branches
  • Testing Library Code — Run unit tests for shared library functions locally
  • Common Use Cases WIP
  • Troubleshooting WIP
  • FAQ

• Jobs information

  • Jobs for repositories in pingcap GitHub organization
  • Jobs for repositories in tikv GitHub organization

• Contributing

  • Workflow for Pipeline Development

Need Help?

• Check our FAQ
• 
• Join our Community Discussions
• Report issues on GitHub

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.