Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 3.05 KB

File metadata and controls

26 lines (19 loc) · 3.05 KB

Documentation Portal

Welcome to the extended documentation for the CPython Patch PR Action. The root README.md stays focused on onboarding. Everything else you need to operate, configure, and develop the action lives in this /docs tree.

Contents

  • Architecture – data flow, modules, and decision points inside the action.
  • Configuration Guide – exhaustive reference for inputs, outputs, environment variables, and permissions.
  • Workflow Recipes – ready-to-adapt GitHub Actions layouts for different rollout strategies.
  • Examples & Outputs – before/after snippets, log excerpts, and output payloads.
  • Development Handbook – local environment setup, scripts, and release hygiene for contributors.
  • Testing Strategy – what we test, how to extend coverage, and how to run suites.
  • Troubleshooting – decode every skip reason and common runtime failure.

How to Use These Docs

  1. New adopters start with the README quick start, then read Workflow Recipes to choose a deployment pattern.
  2. Platform teams should combine Configuration with Troubleshooting to wire secrets and alerts.
  3. Maintainers and contributors should review Architecture, Development, Examples, and Testing before opening pull requests.

Complementary references: