@this-npm-test-org/automation-weekly-report
v0.1.3
Published
End-of-week summary with metrics, trends, highlights, and action items across all connected systems.
Readme
Weekly Report
Runs every Friday afternoon. Compiles a comprehensive weekly summary: key metrics with week-over-week trends, notable events, accomplishments, and open items for next week.
Configuration
schedule: "0 16 * * 5" # 4:00 PM Friday
timezone: "America/New_York"
channel: slack
channel_config:
channel: "#team"
format: blocks
thread: true # Post detailed sections as thread replies
include_sections:
- metrics # Key metrics with WoW comparison
- highlights # Notable wins and completions
- issues # Problems encountered and resolutions
- next_week # Open items and priorities for next weekWhat it does
- Pulls metrics from all connected systems for the past 7 days
- Compares each metric to the prior week and flags significant changes (>10% deviation)
- Identifies notable events: new issues opened, items resolved, milestones reached
- Correlates events across systems (e.g., a deployment that caused alerts)
- Lists open items that need attention next week with priority
- Posts the summary with thread replies for each section
Customize
- Sections: Include or exclude specific report sections
- Metrics: Define which KPIs to track in the knowledge base
- Comparisons: Add month-over-month and year-over-year comparisons
- Distribution: Send to multiple channels or via email
- Tone: Adjust the prompt for executive summary vs detailed team report
Example sections
- Security: Alerts processed, mean time to triage, incidents opened/closed, hunt findings
- Sales: Revenue booked, pipeline added, deals closed, forecast accuracy
- E-commerce: Revenue, AOV, conversion rate, return rate, support volume, ad ROAS
- Property management: Rent collected, maintenance completed, occupancy rate, showings
