User Guide¶
Comprehensive guides covering all depkeeper features and common workflows.
Guides¶
-
Master the
checkcommand with all its options and output formats. -
Safely update packages with backups, dry runs, and selective updates.
-
Understand how depkeeper detects and resolves conflicts.
-
Automate dependency checks in GitHub Actions, GitLab CI, and more.
-
Customize depkeeper behavior via CLI options and environment variables.
-
Recommended practices for dependency management and update workflows.
-
Common issues and their solutions when using depkeeper.
Common Workflows¶
Daily Development¶
# Morning: Check what's outdated
depkeeper check --outdated-only
# When ready: Update safely
depkeeper update --backup -y
Before Release¶
# Full check with conflict resolution
depkeeper check
# Preview updates
depkeeper update --dry-run
# Apply after review
depkeeper update -y
CI/CD Pipeline¶
# Exit non-zero if outdated (for CI notifications)
depkeeper check --format json --outdated-only
# Automated update with backup
depkeeper update --backup -y
Best Practices¶
Version Pinning
Always pin your direct dependencies to specific versions for reproducible builds:
Regular Updates
Check for updates weekly or integrate into your CI/CD pipeline for automated notifications.
Test After Updates
Always run your test suite after updating dependencies:
Major Versions
depkeeper won't cross major version boundaries automatically. When you're ready for a major upgrade, update manually and test thoroughly.