Skip to content

docs(notifications): document report behavior and scheduling - #2183

Draft
felipebergamin wants to merge 1 commit into
mainfrom
docs/notifications-guide
Draft

felipebergamin wants to merge 1 commit into
mainfrom
docs/notifications-guide

Conversation

@felipebergamin

@felipebergamin felipebergamin commented Oct 15, 2026 •

Copy link
Copy Markdown
Member

The notification guide was missing supported actions and still described notification storage as JSON. Update it to match the current implementation, including checkout change detection, subscriptions, recipient routing, SQLite tracking, cron schedules, and email setup.

Validation

  • Checked the documented behavior against the command, queries, email helpers, subscriptions, and cron settings.
  • Verified all 13 local documentation link targets exist.
  • git diff --check passed. Documentation only; no application tests run.

Reviewer instructions

  1. Read docs/notifications.md in GitHub's rendered view and follow its local links.
  2. Compare the actions and options with backend/kernelCI_app/management/commands/notifications.py and the schedule with backend/kernelCI/settings.py.
  3. To check the basic preview example, run from backend/: poetry run python manage.py notifications --action=fake_report. It should print a dry-run report without sending email.

Describe notification actions, subscriptions, recipient routing, storage, and cron jobs. Document CIP status-change gating and the current repeat-report flag behavior.

Related: #2177

Assisted-by: OpenAI Codex
Signed-off-by: Felipe Bergamin <[email protected]>
Comment thread docs/notifications.md

| Action | Behavior |
| ------ | -------- |
| `new_issues` | Looks for recent issues, records newly discovered issue ID/version pairs, and emails a summary. Also generates individual reports for new Maestro build issues. |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great job

Comment thread docs/notifications.md
`new_issues` searches a one-hour window, selects the highest recent version of
each issue, and excludes issues with older incidents. It compares the results
with the issue ID/version pairs already stored in SQLite before rendering the
summary. Test-linked issues enter this discovery path as boot issues.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we ellaborate more on that? Why we have test-linked issues as boot-issues? Only boots (tests with boot path) should be boot issues.

Comment thread docs/notifications.md

### Hardware

Hardware subscription filenames must end in `_hardware.yaml` or `_hardware.yml`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not for this PR, but we could move the type of subscription to the yaml content, instead of having it as filename related.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants