Reports & External Storage

Pull Checklist provides powerful reporting capabilities with the ability to store reports in external storage systems like Amazon S3.

External Storage Setup

Amazon S3 Configuration

You can configure Pull Checklist to store reports in your own Amazon S3 bucket:

1. Navigate to Settings > External Data Targets
2. Click the "New" button
3. Provide the following S3 configuration:
   • Bucket Name
   • Region
   • Access Key ID
   • Secret Access Key

Your credentials should have permissions to upload files to the specified bucket. Reports will be stored in a structured format:

pull-checklist/YYYY-MM-DD/report-name

Creating Reports

To set up automated reports:

1. Go to Settings > Reports
2. Click the "New" button
3. Configure your report with:
   • Name: A descriptive name for the report
   • Report Type: The type of data to include
   • Cadence: How often the report should run
   • Storage Target: Where to store the report (select your configured S3 bucket)

Report Types

Pull Checklist supports various report types to help you track and analyze your pull request workflow.

Report Cadence

Reports can be scheduled to run at different intervals:

• Daily
• Weekly
• Monthly
• On-demand

Accessing Reports

Reports are automatically uploaded to your configured S3 bucket following the specified cadence. Each report is stored with a date-stamped path for easy tracking and retrieval.

File Structure

pull-checklist/
  └── 2023-11-14/
      └── your-report-name
  └── 2023-11-15/
      └── your-report-name

Audit Logging

All report-related activities are automatically logged, including:

• Report creation
• Report modifications
• Report deletions

Each audit log entry includes:

• Timestamp
• User GitHub ID and handle
• Action performed
• Organization name
• Report details

Best Practices

When working with reports and external storage:

• Use dedicated S3 buckets for Pull Checklist data
• Regularly review and clean up old reports
• Monitor storage usage
• Set up appropriate S3 lifecycle policies
• Use restrictive IAM permissions for S3 access

Next Steps

Learn more about:

• Creating checklists
• Enforcing checklist completion
• Condition Engine