Setup putior CI/CD

功能

• GitHub Actions workflow YAML creation
• R script for diagram generation with sentinel markers
• Auto-commit of updated diagrams
• README sentinel integration for in-place diagram updates
• Customizable source directories and branches

使用场景

• When workflow diagrams must always match the code.
• For projects with CI/CD seeking automated documentation updates.
• In multi-contributor environments changing workflow-affecting code.
• To replace manual diagram regeneration with an automated pipeline.

非目标

• Manual diagram generation.
• Diagrams unrelated to the R code's workflow annotations.
• Integration with CI/CD systems other than GitHub Actions.

工作流

1. Create GitHub Actions workflow YAML
2. Write R script for diagram generation and update
3. Configure auto-commit with necessary permissions and guards
4. Add sentinel markers to the target file (e.g., README.md)
5. Test the pipeline by triggering a commit and verifying diagram updates

实践

• Workflow automation
• CI/CD setup
• Documentation synchronization

先决条件

• GitHub repository with putior annotations in source files
• Target file for diagram output (e.g., README.md, docs/workflow.md)
• R environment with 'putior' and 'r-lib/actions/setup-r' installed