Environment:Kubeflow Kubeflow Git GitHub Environment
| Knowledge Sources | |
|---|---|
| Domains | Version_Control, Contributing, Release_Management |
| Last Updated | 2026-02-13 00:00 GMT |
Overview
Git and GitHub environment required for contributing to Kubeflow and managing release processes.
Description
This environment defines the version control tooling required for the Contributing to Kubeflow and Release Management workflows. Git is needed to clone repositories, create branches, and submit pull requests. GitHub CLI (gh) simplifies PR creation, issue management, and release tagging. Contributors must also have a GitHub account with the ability to fork Kubeflow repositories and sign commits with a DCO (Developer Certificate of Origin) sign-off.
Usage
Use this environment when contributing code or documentation to any Kubeflow sub-project, when managing releases (tagging, container image publishing), or when interacting with GitHub Issues and Project Boards for release tracking.
System Requirements
| Category | Requirement | Notes |
|---|---|---|
| OS | Linux, macOS, or Windows | Any platform with Git support |
| Git | >= 2.30 | Required for DCO sign-off (git commit -s)
|
| GitHub CLI | >= 2.0 (optional) | Simplifies PR and release management |
| Network | Access to github.com | HTTPS or SSH access to GitHub repositories |
Dependencies
System Packages
- git >= 2.30
- gh (GitHub CLI, optional but recommended)
Credentials
The following credentials must be configured:
- GitHub SSH key or HTTPS token: For push access to forked repositories
- Git user.name and user.email: Must be configured for DCO sign-off compliance
- GITHUB_TOKEN: For GitHub CLI authentication and API access (optional, used by gh CLI)
Quick Install
# Install Git (Ubuntu/Debian)
sudo apt-get install git
# Configure identity for DCO sign-off
git config --global user.name "Your Name"
git config --global user.email "your.email@example.com"
# Install GitHub CLI (optional)
sudo apt-get install gh
gh auth login
# Verify
git --version
gh --version
Code Evidence
DCO sign-off requirement from CONTRIBUTING.md:
Please see our contributor guide for more information on how to get started.
The contributor guide at kubeflow.org requires DCO sign-off on all commits, enforced via the GitHub PR workflow.
Stale bot configuration from .github/stale.yml:L4-5:
daysUntilStale: 90
daysUntilClose: 7
Issue routing from .github/ISSUE_TEMPLATE/config.yml:L1-2:
blank_issues_enabled: false
contact_links:
Common Errors
| Error Message | Cause | Solution |
|---|---|---|
DCO check failed |
Commit not signed off | Amend commit with git commit --amend -s or add Signed-off-by: line
|
Permission denied (publickey) |
SSH key not configured for GitHub | Add SSH key to GitHub account or use HTTPS with token |
remote: Permission to kubeflow/X denied |
Pushing to upstream instead of fork | Push to your fork and create PR from there |
Compatibility Notes
- DCO requirement: All Kubeflow repositories require Developer Certificate of Origin sign-off on every commit. Use
git commit -sto add the sign-off line automatically. - Issue routing: The main kubeflow/kubeflow repository does not accept issues directly. Issues are routed to specific sub-project repositories via the .github/ISSUE_TEMPLATE/config.yml contact links.
- Release tagging: Release managers need write access to the repository for git tagging and container image pushing.