Shell/Daily: Interleave Attention vs. CI reports

Author: amotl

CHANGES.md

@@ -14,6 +14,7 @@
 - GitHub/Actions: Permitted commandeering the time interval per `--when` option
 - GitHub/Actions: Added filtering duplicates
 - GitHub/Activity: Added section about "Top issues"
+- Shell/Daily: Interleaved Attention vs. CI reports
 
 ## v0.3.0, 2025-02-24
 - Opsgenie: Added alert reporter. Thanks, @WalBah.

docs/backlog.md

@@ -1,9 +1,8 @@
 # Backlog
 
 ## Iteration +1
-- Shell/Daily: Interleave CI reports
-- Aika: Fix bugs and refactor code
-- Pueblo: Fix bugs and refactor code
+- `rapporto report` without `--github-repository` should iterate **all** repositories
+- Bugfixing and refactoring: Aika and Pueblo
 
 ## Iteration +2
 - Options: Program currently understands `--slack-token=`, but lacks `--github-token=`
@@ -84,3 +83,4 @@
 - UI/Slack: Improve zapping
 - GitHub/Actions: Currently lacks parameter `--when`
 - GitHub/Activity: Section about "Top issues"
+- Shell/Daily: Interleave CI reports

docs/report/index.md

@@ -40,34 +40,44 @@ export SLACK_TOKEN="xoxb-your-slack-bot-token"
 Alternatively to using the environment variable, you can also use the
 `rapporto notify --slack-token=` command-line option.
 
-### Options
-
-The [`--when`](#when-option) command-line option accepts a wide range of
-values to adjust the time interval. You can also omit the option completely,
-in which case the program will assume the current day or calendar week.
-
 ## Markdown Reports
 
-Report about given day.
+Report attention items about a given day.
 ```shell
-rapporto report --github-organization="acme" daily --when="2025-02-28"
+rapporto report --github-organization="acme" daily --day="2025-02-28"
 ```
 
 Report about given calendar week.
 ```shell
-rapporto report --github-organization="acme" weekly --when="2025W09"
+rapporto report --github-organization="acme" weekly --day="2025W09"
 ```
 
 Print yesterday's report.
 ```shell
-rapporto report --github-organization="acme" daily --when="yesterday"
+rapporto report --github-organization="acme" daily --day="yesterday"
 ```
 
 Print today's report in YAML format.
 ```shell
 rapporto report --github-organization="acme" --format="yaml" daily
 ```
 
+Report attention items and CI failures about a given day.
+```shell
+rapporto report \
+  --github-organization="acme" \
+  --github-repository="acme/foobar" \
+  daily --day="2025-02-28"
+```
+
+Load list of repositories from file.
+```shell
+rapporto report \
+  --github-organization="acme" \
+  --github-repository="/path/to/repositories.txt" \
+  daily --day="2025-02-28"
+```
+
 
 ## Slack Conversations
 
@@ -81,6 +91,14 @@ Report and notify about given calendar week.
 rapporto notify --gh-org="acme" --slack-channel="janitor-bot" weekly --week="2025W09"
 ```
 
+Report and notify about given calendar week, loading list of repositories from file.
+```shell
+rapporto notify \
+  --gh-org="acme" --gh-repo="/path/to/repositories.txt" \
+  --slack-channel="janitor-bot" \
+  weekly --week="2025W09"
+```
+
 For development purposes, zap messages after pressing enter.
 ```shell
 rapporto notify --gh-org="acme" --slack-channel="janitor-bot" weekly --zap=key

src/rapporto/notify/cli.py

@@ -5,30 +5,39 @@
 from pueblo_goof.slack.conversation import SlackConversation
 from pueblo_goof.slack.model import SlackOptions, slack_api_token_option, slack_channel_option
 from pueblo_goof.util import Zapper
-from rapporto.option import github_organization_option
+from rapporto.option import github_organization_option, github_repository_option
 from rapporto.report.model import ReportOptions
 from rapporto.report.slack import SlackWeekly
+from rapporto.source.github.model import GitHubOptions
 
 logger = logging.getLogger(__name__)
 
 
 @click.group()
 @github_organization_option
+@github_repository_option
 @slack_api_token_option
 @slack_channel_option
 @click.pass_context
-def cli(ctx: click.Context, github_organization: str, slack_token: str, slack_channel: str):
+def cli(
+    ctx: click.Context,
+    github_organization: str,
+    github_repository: str,
+    slack_token: str,
+    slack_channel: str,
+):
     """
     Notify humans and machines.
     """
     if not slack_token:
         raise click.UsageError(
             "Missing option '--slack-token' or environment variable 'SLACK_TOKEN'."
         )
-    ctx.meta["slack_options"] = SlackOptions(token=slack_token, channel=slack_channel)
-    ctx.meta["report_options"] = ReportOptions(
-        github_organization=github_organization, output_format="markdown"
+    ctx.meta["github_options"] = GitHubOptions(organization=github_organization).add_repos(
+        github_repository
     )
+    ctx.meta["slack_options"] = SlackOptions(token=slack_token, channel=slack_channel)
+    ctx.meta["report_options"] = ReportOptions(output_format="markdown")
 
 
 @cli.command()
@@ -40,13 +49,19 @@ def weekly(ctx: click.Context, week: str, zap: str):
     Weekly report converged into Slack thread.
     """
 
+    github_options: GitHubOptions = ctx.meta["github_options"]
     report_options: ReportOptions = ctx.meta["report_options"]
     slack_options: SlackOptions = ctx.meta["slack_options"]
 
     conversation = SlackConversation(options=slack_options)
     zapper = Zapper(when=zap, action=conversation.delete)
 
-    section = SlackWeekly(week=week, options=report_options, conversation=conversation)
+    section = SlackWeekly(
+        week=week,
+        github_options=github_options,
+        report_options=report_options,
+        conversation=conversation,
+    )
     section.refresh()
 
     try:

src/rapporto/option.py

@@ -1,5 +1,21 @@
 import click
 
 github_organization_option = click.option(
-    "--github-organization", "--gh-org", type=str, required=True
+    "--github-organization", "--gh-org", type=str, required=True, help="GitHub organization name"
 )
+github_repository_option = click.option(
+    "--github-repository",
+    "--gh-repo",
+    type=str,
+    required=True,
+    help="GitHub repository, single or path to file",
+)
+format_option = click.option(
+    "--format",
+    "format_",
+    type=str,
+    required=False,
+    default="markdown",
+    help="Output format. Default: markdown",
+)
+when_option = click.option("--when", type=str, required=False, help="Point in time")

src/rapporto/report/cli.py

@@ -2,52 +2,60 @@
 
 import click
 
-from rapporto.option import github_organization_option
+from rapporto.option import (
+    format_option,
+    github_organization_option,
+    github_repository_option,
+)
 from rapporto.report.model import DailyReport, ReportOptions, WeeklyReport
+from rapporto.source.github.model import GitHubOptions
 
 logger = logging.getLogger(__name__)
 
-format_option = click.option("--format", "format_", type=str, required=True, default="markdown")
-
 
 @click.group()
 @github_organization_option
+@github_repository_option
 @format_option
 @click.pass_context
-def cli(ctx: click.Context, github_organization: str, format_: str):
+def cli(ctx: click.Context, github_organization: str, github_repository: str, format_: str):
     """
     Generate reports.
     """
-    ctx.meta["options"] = ReportOptions(
-        github_organization=github_organization, output_format=format_
+    ctx.meta["github_options"] = GitHubOptions(organization=github_organization).add_repos(
+        github_repository
     )
+    ctx.meta["report_options"] = ReportOptions(output_format=format_)
 
 
 @cli.command()
-@click.option("--when", type=str, required=False, help="Point in time")
+@click.option("--day", type=str, required=False, help="Day in ISO format, e.g. 2025-03-03")
 @click.pass_context
-def daily(ctx: click.Context, when: str):
+def daily(ctx: click.Context, day: str):
     """
     Daily report.
     """
     report = DailyReport(
-        day=when,
-        options=ctx.meta["options"],
+        day=day,
+        github_options=ctx.meta["github_options"],
+        report_options=ctx.meta["report_options"],
     )
     report.process()
-    print(report.render(report.options.output_format))
+    print(report.render(report.report_options.output_format))
 
 
 @cli.command()
-@click.option("--when", type=str, required=False, help="Point in time")
+@click.option("--week", type=str, required=False, help="Calendar week in ISO format, e.g. 2025W03")
+@github_repository_option
 @click.pass_context
-def weekly(ctx: click.Context, when: str):
+def weekly(ctx: click.Context, week: str):
     """
     Weekly report.
     """
     report = WeeklyReport(
-        week=when,
-        options=ctx.meta["options"],
+        week=week,
+        github_options=ctx.meta["github_options"],
+        report_options=ctx.meta["report_options"],
     )
     report.process()
-    print(report.render(report.options.output_format))
+    print(report.render(report.report_options.output_format))

src/rapporto/report/model.py

@@ -6,8 +6,9 @@
 import yaml
 from attrs import define
 
+from rapporto.source.github.actions import GitHubActionsReport
 from rapporto.source.github.attention import GitHubAttentionReport
-from rapporto.source.github.model import GitHubInquiry
+from rapporto.source.github.model import GitHubInquiry, GitHubMultiRepositoryInquiry, GitHubOptions
 from rapporto.util import week_to_day_range
 
 
@@ -39,7 +40,6 @@ class ReportOptions:
     Composite report options.
     """
 
-    github_organization: str
     output_format: str = "markdown"
 
 
@@ -92,7 +92,8 @@ class DailyReport(ReportBase):
     """
 
     day: str
-    options: ReportOptions
+    github_options: GitHubOptions
+    report_options: ReportOptions
     items: t.List[DailyItem] = attr.field(factory=list)
 
     def __attrs_post_init__(self):
@@ -106,14 +107,28 @@ def process(self):
         """
         Generate set of reports across different domains or topics.
         """
+        self.github_actions()
         self.github_attention()
 
+    def github_actions(self):
+        """
+        CI workflow run failures on GitHub.
+        """
+        # TODO: Use `TimeIntervalParser`.
+        created = f"{self.day}..{self.day}"
+        inquiry = GitHubMultiRepositoryInquiry(
+            repositories=self.github_options.repositories, created=created
+        )
+        report = GitHubActionsReport(inquiry=inquiry)
+        self.items.append(DailyItem(type="github-actions", day=self.day, markdown=report.markdown))
+
     def github_attention(self):
         """
         Items on GitHub that deserve your attention.
         """
+        # TODO: Use `TimeIntervalParser`.
         updated = f"{self.day}..{self.day}"
-        inquiry = GitHubInquiry(organization=self.options.github_organization, updated=updated)
+        inquiry = GitHubInquiry(organization=self.github_options.organization, updated=updated)
         report = GitHubAttentionReport(inquiry=inquiry)
         self.items.append(
             DailyItem(type="github-attention", day=self.day, markdown=report.markdown)
@@ -133,7 +148,8 @@ class WeeklyReport(ReportBase):
     """
 
     week: str
-    options: ReportOptions
+    github_options: GitHubOptions
+    report_options: ReportOptions
     dailies: t.List[DailyReport] = attr.field(factory=list)
 
     SKIP_THE_FUTURE = True
@@ -159,7 +175,9 @@ def process(self):
         Create all daily reports.
         """
         for day in self.days:
-            report = DailyReport(day=day, options=self.options)
+            report = DailyReport(
+                day=day, github_options=self.github_options, report_options=self.report_options
+            )
             report.process()
             self.dailies.append(report)
 

src/rapporto/report/slack.py

@@ -9,6 +9,7 @@
 
 from pueblo_goof.slack.conversation import SlackConversation
 from rapporto.report.model import DailyItem, ReportOptions, WeeklyReport
+from rapporto.source.github.model import GitHubOptions
 
 logger = logging.getLogger(__name__)
 
@@ -24,7 +25,8 @@ class SlackWeekly:
     AUTHOR = "qa-bot"
 
     week: str
-    options: ReportOptions
+    github_options: GitHubOptions
+    report_options: ReportOptions
     conversation: SlackConversation
 
     # Message id of the root message.
@@ -87,7 +89,8 @@ def root_markdown(self):
     def render(self):
         weekly = WeeklyReport(
             week=self.week,
-            options=self.options,
+            github_options=self.github_options,
+            report_options=self.report_options,
         )
         weekly.process()
         for daily_report in weekly.dailies: