Skip to content

Prevent blank maintenance metadata from breaking monitoring #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
masterfung merged 1 commit into from
Aug 17, 2026
Merged

Prevent blank maintenance metadata from breaking monitoring #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions .github/ISSUE_TEMPLATE/scheduled-maintenance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,18 @@ assignees: ""
---

> **Required:** Replace both 2000 timestamps with the approved UTC start/end.
> List only genuinely affected slugs after `expectedDown` or
> `expectedDegraded`; leave the value empty when that impact is not expected.
> Add `expectedDown` or `expectedDegraded` inside the metadata comment only
> when that impact is expected. Never leave either key with an empty value;
> the pinned monitor cannot parse an empty `key:` line.

<!--
start: 2000-01-01T00:00:00Z
end: 2000-01-01T00:30:00Z
expectedDown:
expectedDegraded:
-->

Valid component slugs: `website`, `api`, `scan-gateway`.
Optional metadata examples: `expectedDown: api` and
`expectedDegraded: website, scan-gateway`.

## Summary

Expand Down
10 changes: 8 additions & 2 deletions scripts/validate.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,8 +165,14 @@ def check(condition, message)
"first maintenance comment needs a safe start placeholder")
check(first_metadata.include?("end: 2000-01-01T00:30:00Z"),
"first maintenance comment needs a safe end placeholder")
check(first_metadata.include?("expectedDown:") && first_metadata.include?("expectedDegraded:"),
"first maintenance comment needs optional impact metadata")
blank_impact_metadata = first_metadata.lines.any? do |line|
line.match?(/^\s*expected(?:Down|Degraded):\s*$/)
end
check(!blank_impact_metadata,
"maintenance metadata must not contain blank expectedDown/expectedDegraded values")
check(issue_template.include?("expectedDown: api") &&
issue_template.include?("expectedDegraded: website, scan-gateway"),
"maintenance template needs safe optional impact examples")

if ERRORS.empty?
puts "Status configuration validation passed (#{sites.length} components, full-SHA workflows)."
Expand Down