OpenDev Manual

The projects hosted by OpenDev use a number of specialized tools and processes while developing software that is part of the projects. This manual will help you learn how to use them as a developer working on any project hosted in the OpenDev infrastructure.

Important

You can always check the status of the OpenDev CI infrastructure via:

• https://wiki.openstack.org/wiki/Infrastructure_Status

• @OpenStackInfra on Twitter.

• the topic in IRC

If you notice problems, report them via #opendev on IRC or use the service-discuss mailing list.

• Getting Started
  • The OpenDev Workflow
  • Setting up your Gerrit account
  • Proposing a change
  • Next steps
• Developer’s Guide
  • Accounts creation
  • Development Workflow
  • Code Review
  • Merging
• IRC Guide
  • Channel Logging
  • Just Start Talking
  • Talking to specific people
  • Use a pastebin for communicating long content
  • Technical Support
  • Persistent Clients and IRC Bouncers
• Core Reviewer’s Guide
  • Maintaining the Core Group
  • +/-2 votes
  • Approval
  • Work In Progress
  • Re-approval
• Project Driver’s Guide
  • Branches
  • Tagging a Release
  • Gerrit IRC Notifications
  • Running Jobs with Zuul
  • Retiring a Project
  • Package Requirements
  • Unit Test Set up
  • Consistent Naming for Zuul Jobs
  • Outbound Third-Party Testing
• Project Creator’s Guide
  • Before You Start
  • Decide Status and Namespace of your Project
  • Choosing a Good Name for Your Project
  • Give OpenDev Permission to Publish Releases
  • Give OpenDev Exclusive Permission to Publish Releases
  • Adding the Project to the CI System
  • Preparing a New Git Repository using cookiecutter
  • Mirroring Projects to Git Mirrors
  • Verify That Gerrit and the Test Jobs are Working
  • Prepare an Initial Release
  • Allowing Other OpenStack Projects to Use Your Library
  • Setting up Gate Testing
  • Add Links to Your Project Documentation
  • Project Renames
  • Review List for New Projects
• Learn the Gerrit Workflow in the Sandbox
• Test Environment
  • Unprivileged Single Use VMs
  • Known Differences to Watch Out For
  • Why are Jobs for Changes Queued for a Long Time
  • Handling Zuul Secrets

Many projects hosted on OpenDev have their own Contributor Guides that explain project specific information. A non-complete list of these are:

• OpenStack Contributors Guide

• StarlingX Contributor Guides

Propose changes to this document to the infra-manual git repository.