Welcome to the duchamp documentation! This directory contains comprehensive guides for using and contributing to duchamp, Artsy's collection of reusable GitHub Actions.
| Guide | Purpose | Best For |
|---|---|---|
| Getting Started | Basic setup and integration | New users setting up duchamp for the first time |
| Available Actions | Complete reference for all actions | Developers needing detailed action specifications |
| Usage Examples | Real-world configuration examples | Teams implementing duchamp in different project types |
- New to duchamp? Start with Getting Started
- Need specific action details? Check Available Actions
- Want to see examples? Browse Usage Examples
- Setting up Danger.js checks: Getting Started → Basic Integration
- Auto-labeling PRs: Actions → run-add-version-label.yml
- Custom Danger rules: Examples → Custom Danger Rules
- Node.js project setup: Examples → Basic Node.js Project
- React/Frontend: Examples → React/Frontend Project
- API/Backend: Examples → API/Backend Project
- Library with releases: Examples → Library with Auto-Release
- Monorepo: Examples → Monorepo Configuration
- Questions: Ask in #practice-platform 🔒
- Issues: Create GitHub Issues
- Maintainers: @amonkhouse, @mc-jones
This documentation follows Artsy's documentation best practices:
- Clear structure with logical progression
- Real-world examples rather than theoretical
- Troubleshooting included for common issues
- Up-to-date with current duchamp functionality
- Accessible to both new and experienced developers
- Watch this repository for documentation updates
- Check release notes for new features and changes
- Follow @ArtsyOpenSource for Artsy engineering updates