Logo
latest
  • User’s Guide
    • Zuul Concepts
    • Project Gating
      • Testing in parallel
      • Cross Project Testing
      • Cross-Project Dependencies
        • Dependent Pipeline
        • Independent Pipeline
        • Multiple Changes
        • Cycles
    • Project Configuration
      • Security Contexts
      • Configuration Loading
      • Configuration Items
        • Pipeline
        • Job
        • Project
        • Project Template
        • Secret
        • Nodeset
        • Semaphore
        • Pragma
    • Job Content
      • Working Directory
      • Git Repositories
      • Variables
        • Site-wide Variables
        • Job Extra Variables
        • Secrets
        • Job Variables
        • Project Variables
        • Parent Job Results
      • Zuul Variables
        • Change Items
        • Branch Items
        • Tag Items
        • Ref Items
        • Working Directory
      • SSH Keys
        • Nodepool Key
        • Project Key
      • Return Values
        • Returning the log url
        • Returning artifact URLs
        • Skipping child jobs
        • Leaving file comments
        • Pausing the job
      • Build Status
    • Encryption
    • Badges
    • HowTos: Recommended Practices
      • Project Testing Interface
        • Projects layout
          • org-config
          • org-jobs
        • Projects content
        • Usage
          • Project tests
          • Updating PTI test
        • Cross project gating
      • Cross Project Gating
        • Python
        • Packaging
    • Vulnerability Reporting
      • Create a Private Story in StoryBoard
      • Report via Encrypted E-mail
  • Administrator’s Guide
    • Quick-Start Installation and Tutorial
      • Start Zuul Containers
      • Add Your Gerrit Account
      • Configure Zuul Pipelines
      • Test Zuul Pipelines
      • Configure a Base Job
      • Further Steps
    • Installation Reference
      • Install Zuul
      • Zuul Components
      • External Dependencies
        • Gearman
        • Nodepool
        • Ansible
      • Zuul Setup
      • Starting Zuul
      • Web Deployment Options
        • Reverse Proxy
        • Static Offload
        • Sub directory serving
        • White Labeled Tenant
        • Static External
    • Zuul From Scratch
      • Environment Setup
      • Installation
      • Configuration
        • Nodepool
        • Zuul
      • Starting Services
      • Use Zuul Jobs
      • Setup Your Repo
    • Components
      • Common
        • Configuration
      • Scheduler
        • Configuration
        • Operation
      • Merger
        • Configuration
        • Operation
      • Executor
        • Trusted and Untrusted Playbooks
        • Configuration
        • Operation
      • Web Server
        • Configuration
        • Operation
      • Finger Gateway
        • Configuration
        • Operation
    • Connection Configuration
      • Connections
      • Drivers
        • Gerrit
          • Connection Configuration
          • Trigger Configuration
          • Reporter Configuration
          • Requirements Configuration
        • GitHub
          • Configure GitHub
            • Web-Hook
            • Application
          • Connection Configuration
          • Trigger Configuration
          • Reporter Configuration
          • Requirements Configuration
        • Git
          • Connection Configuration
          • Trigger Configuration
        • MQTT
          • Message Schema
          • Connection Configuration
          • Reporter Configuration
        • SMTP
          • Connection Configuration
          • Reporter Configuration
        • SQL
          • Connection Configuration
          • Reporter Configuration
        • Timer
          • Trgger Configuration
        • Zuul
          • Trigger Configuration
    • Tenant Configuration
      • Tenant
    • Monitoring
      • Statsd reporting
        • Configuration
        • Metrics
    • Zuul Client
      • Configuration
      • Usage
        • Autohold
        • Dequeue
        • Enqueue
        • Enqueue-ref
          • Manual enqueue examples
        • Promote
        • Show
        • tenant-conf-check
    • Troubleshooting
      • Gearman Jobs
  • Developer’s Guide
    • Data Model
      • Changes
      • Filters
      • Tenants
      • Other Global Objects
    • Drivers
    • Triggers
    • Testing
    • Documentation
      • ReStructuredText Conventions
        • Code Blocks
        • Literal Values
        • Terminology
      • Zuul Sphinx Directives
        • zuul:attr::
        • zuul:value::
        • zuul:var::
      • Zuul Sphinx Roles
    • Ansible Integration
      • Restricted Execution
      • Build Log Support
    • Zuul Dashboard Javascript
      • For the impatient who don’t want deal with javascript toolchains
      • yarn dependency management
      • Dealing with yarn.lock merge conflicts
      • React Components
      • Development
      • Deploying
    • Specifications
      • Use Kubernetes for Build Resources
        • Containers That Behave Like a Machine
        • Native Container Workflow
        • Synchronizing Git Repos
        • BuildSet Resources
    • Release Notes
      • Installing reno
      • Adding a new release note
  • Release Notes
    • 3.5.0
      • New Features
      • Upgrade Notes
      • Security Issues
      • Bug Fixes
    • 3.4.0
      • New Features
      • Upgrade Notes
    • 3.3.1
      • New Features
      • Upgrade Notes
      • Security Issues
      • Bug Fixes
    • 3.3.0
      • New Features
      • Upgrade Notes
      • Deprecation Notes
    • 3.2.0
      • New Features
      • Bug Fixes
    • 3.1.0
      • New Features
      • Upgrade Notes
      • Security Issues
      • Bug Fixes
    • 3.0.3
      • New Features
      • Deprecation Notes
      • Bug Fixes
    • 3.0.2
      • New Features
      • Upgrade Notes
      • Bug Fixes
    • 3.0.1
      • New Features
      • Upgrade Notes
      • Bug Fixes
  • Zuul Project Governance
    • Zuul Maintainers
    • Zuul Project Lead
    • Zuul-Jobs Maintainers
  • Glossary
Zuul
  • »
  • User’s Guide »
  • HowTos: Recommended Practices
  • View page source

HowTos: Recommended Practices

  • Project Testing Interface
    • Projects layout
    • Projects content
    • Usage
    • Cross project gating
  • Cross Project Gating
    • Python
    • Packaging
Previous Next

© Copyright 2012-2022, Zuul project contributors.

Built with Sphinx using a theme provided by Read the Docs.
Versions v: latest
latest
4.11.0
4.10.4
4.10.3
4.10.2
4.10.1
4.10.0
4.9.0
4.8.1
4.8.0
4.7.0
4.6.0
4.5.1
4.5.0
4.4.0
4.3.0
4.2.0
4.1.0
4.0.0
3.19.1
3.19.0
3.18.0
3.17.0
3.16.1
3.16.0
3.15.0
3.14.0
3.13.0
3.12.0
3.11.1
3.11.0
3.10.2
3.10.1
3.10.0
3.9.0
3.8.1
3.8.0
3.7.1
3.7.0
3.6.1
3.6.0
3.5.0
3.4.0
3.3.1
3.3.0