{"id":28690578,"url":"https://github.com/thunderbird/thunderbird-notifications","last_synced_at":"2026-03-07T07:32:16.863Z","repository":{"id":235241241,"uuid":"790359853","full_name":"thunderbird/thunderbird-notifications","owner":"thunderbird","description":"In-App notifications for Thunderbird","archived":false,"fork":false,"pushed_at":"2026-02-27T22:06:52.000Z","size":202,"stargazers_count":4,"open_issues_count":23,"forks_count":6,"subscribers_count":11,"default_branch":"main","last_synced_at":"2026-02-27T23:48:52.594Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thunderbird.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-04-22T18:29:43.000Z","updated_at":"2026-02-27T22:06:57.000Z","dependencies_parsed_at":"2024-06-10T20:04:06.062Z","dependency_job_id":"d19bdbb7-252d-45bb-a8e6-ebb59fe9b309","html_url":"https://github.com/thunderbird/thunderbird-notifications","commit_stats":null,"previous_names":["thunderbird/thunderbird-notifications"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/thunderbird/thunderbird-notifications","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thunderbird%2Fthunderbird-notifications","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thunderbird%2Fthunderbird-notifications/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thunderbird%2Fthunderbird-notifications/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thunderbird%2Fthunderbird-notifications/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thunderbird","download_url":"https://codeload.github.com/thunderbird/thunderbird-notifications/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thunderbird%2Fthunderbird-notifications/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30209729,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T05:23:27.321Z","status":"ssl_error","status_checked_at":"2026-03-07T05:00:17.256Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-14T06:05:28.994Z","updated_at":"2026-03-07T07:32:16.858Z","avatar_url":"https://github.com/thunderbird.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# thunderbird-notifications\n\nServer-side notification definitions for Thunderbird's [in-app notification system](https://source-docs.thunderbird.net/en/latest/inappnotifications/index.html). This repo contains:\n\n- YAML notification definitions for stage and production\n- JSON schema describing the notification data format\n- Scripts for converting YAML to JSON and validating against the schema\n- CI/CD pipeline that validates, converts, and deploys notifications via Pulumi\n\n## Contributing\n\n1. Create a branch and add or edit YAML files in `stage/yaml/`.\n2. Run the conversion and validation scripts locally to verify your changes (see [Development Setup](#development-setup)).\n3. Open a pull request — CI will automatically validate the YAML.\n4. Once merged to `main`, the stage environment is deployed automatically.\n5. To promote to production, copy the YAML file into `prod/yaml/` and open another PR. The production deploy requires manual approval in GitHub Actions.\n\n### Development Setup\n\nYou'll first need to setup [uv](https://docs.astral.sh/uv/getting-started/installation/).\n\n```shell\n# Download python 3.14\nuv python install 3.14\n\n# Create the virtual environment\nuv venv\n\n# Install the requirements\nuv sync\n\n# Run the conversion script\nuv run python scripts/convert_yaml.py stage/yaml stage/json/notifications.json\n\n# Validate the output\nuv run python scripts/validate_json.py ./schema.json stage/json\n```\n\nReplace `stage` with `prod` to convert and validate production notifications.\n\n## Deploying\n\nDeployment is handled automatically by GitHub Actions when changes are merged to `main`. See the [dedicated deployment documentation](./docs/deploying.rst) for details on the automated workflow, environment protection rules, manual Pulumi usage, and cache clearing.\n\n## Notification Format\n\nEach notification is a YAML file in `stage/yaml/` or `prod/yaml/`. Files can contain one or more notifications as a YAML list. For a full explanation of the format, types, targeting, and client behavior, see the [Thunderbird source documentation](https://source-docs.thunderbird.net/en/latest/inappnotifications/index.html).\n\n### Example\n\n```yaml\n- id: my-notification-en\n  start_at: 2025-12-01T00:00:00.000Z\n  end_at: 2025-12-19T00:00:00.000Z\n  title: \"Upcoming Account Change\"\n  description: \"We're switching to a more secure login system.\"\n  CTA: \"Learn More\"\n  URL: https://example.com\n  severity: 1\n  type: security\n  targeting:\n    include:\n      - { channels: [release], locales: [en-US, en-GB] }\n    percent_chance: 100\n```\n\n### Schema Reference\n\n#### Notification\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| `id` | string | yes | Unique ID set by the server. |\n| `start_at` | datetime | yes | UTC timestamp after which Thunderbird will show the notification. |\n| `end_at` | datetime | yes | UTC timestamp after which the notification is never shown. |\n| `title` | string | yes | Short sentence displayed in the Thunderbird UI. |\n| `description` | string | no | A short paragraph displayed in the Thunderbird UI. |\n| `URL` | url \\| null | no | URL to open from the CTA, if any. |\n| `CTA` | string \\| null | no | Link text to show for the URL. |\n| `severity` | integer | yes | 1 (most urgent) through 5 (least urgent). |\n| `type` | string | yes | One of: `donation`, `donation_tab`, `donation_browser`, `message`, `security`, `blog`. |\n| `position` | string \\| null | no | Where the notification appears: `bottom-today-pane` or `bottom-spaces-toolbar`. No effect for tab/browser types. |\n| `targeting` | object | yes | Targeting criteria (see below). |\n\n#### Targeting\n\n| Field | Type | Default | Description |\n|-------|------|---------|-------------|\n| `percent_chance` | number (0–100) \\| null | null | Percentage of users who should see the notification. |\n| `exclude` | array \\| null | null | Profiles to exclude (objects are ORed, keys within are ANDed). |\n| `include` | array \\| null | null | Profiles to include (objects are ORed, keys within are ANDed). |\n\n#### Profile (used in `exclude`/`include`)\n\n| Field | Type | Description |\n|-------|------|-------------|\n| `locales` | string[] \\| null | BCP 47 locale tags (e.g. `en-US`, `de`, `fr`). |\n| `versions` | string[] \\| null | Application version strings. |\n| `channels` | string[] \\| null | One of: `default`, `esr`, `release`, `beta`, `nightly`. |\n| `operating_systems` | string[] \\| null | One of: `win`, `macosx`, `linux`, `freebsd`, `openbsd`, `netbsd`, `solaris`, `other`. |\n| `displayed_notifications` | string[] \\| null | IDs of notifications previously displayed to the user. |\n| `pref_true` | string[] \\| null | Thunderbird boolean prefs that must be true. |\n| `pref_false` | string[] \\| null | Thunderbird boolean prefs that must be false. |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthunderbird%2Fthunderbird-notifications","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthunderbird%2Fthunderbird-notifications","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthunderbird%2Fthunderbird-notifications/lists"}