Skip to content

docs(edge-apps): add Sentry error reporting guidance#883

Merged
nicomiguelino merged 4 commits into
masterfrom
docs/edge-app-sentry-dsn-setting
Jul 17, 2026
Merged

docs(edge-apps): add Sentry error reporting guidance#883
nicomiguelino merged 4 commits into
masterfrom
docs/edge-app-sentry-dsn-setting

Conversation

@nicomiguelino

Copy link
Copy Markdown
Contributor

Summary

  • Add a new "Error Reporting (Sentry)" section to the create-an-edge-app skill documenting the sentry_dsn setting pattern (type: secret, optional: true, is_global: true).
  • Document setupSentry/reportError usage from @screenly/edge-apps/utils.
  • Reference Screenly/salesforce-app and Screenly/powerbi-app as implementation examples.

Test plan

  • Docs-only change; no code to test.

- document sentry_dsn as a global secret setting
- describe setupSentry/reportError usage from @screenly/edge-apps/utils
- reference salesforce-app and powerbi-app implementations
@nicomiguelino
nicomiguelino requested a review from Copilot July 17, 2026 16:57
@github-actions

Copy link
Copy Markdown

Failed to generate code suggestions for PR

Copilot AI left a comment

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.

Pull request overview

Adds Sentry error-reporting guidance to the “create-an-edge-app” skill so new Edge Apps standardize on an optional sentry_dsn setting and consistent usage of @screenly/edge-apps/utils Sentry helpers.

Changes:

  • Document an optional sentry_dsn manifest setting pattern (type: secret, optional: true, is_global: true).
  • Document setupSentry and reportError usage patterns and operational guidance (deduping repeated failures).
  • Link to Salesforce/PowerBI Edge Apps as reference implementations.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .claude/skills/create-an-edge-app/SKILL.md Outdated
Comment thread .claude/skills/create-an-edge-app/SKILL.md Outdated
- add explicit YAML example for the sentry_dsn setting
- fix setupSentry example to use valid syntax
- reference src/main.ts consistently with the rest of the doc

Copilot AI left a comment

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.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread .claude/skills/create-an-edge-app/SKILL.md

Copilot AI left a comment

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.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comment thread .claude/skills/create-an-edge-app/SKILL.md Outdated
- replace app-specific content_id with screenly.metadata.screen_name,
  which is available in every Edge App

Copilot AI left a comment

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.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Comment thread .claude/skills/create-an-edge-app/SKILL.md Outdated
Comment thread .claude/skills/create-an-edge-app/SKILL.md Outdated
- scope the guidance to new apps rather than all apps
- make the help_text example copy-pasteable
@nicomiguelino
nicomiguelino marked this pull request as ready for review July 17, 2026 17:36
@github-actions

Copy link
Copy Markdown

Failed to generate code suggestions for PR

@nicomiguelino
nicomiguelino merged commit b1c22f1 into master Jul 17, 2026
1 check passed
@nicomiguelino
nicomiguelino deleted the docs/edge-app-sentry-dsn-setting branch July 17, 2026 19:03
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.

3 participants