Skip to content

develop-docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

develop-docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
github-pages
github-pages
 
 
AGENTS.md
AGENTS.md
 
 
ARCHITECTURE.md
ARCHITECTURE.md
 
 
BUILD.md
BUILD.md
 
 
CI.md
CI.md
 
 
DECISIONS.md
DECISIONS.md
 
 
Fishhook-Explanation.md
Fishhook-Explanation.md
 
 
INTEGRATIONS.md
INTEGRATIONS.md
 
 
OBJC-LOAD-AND-LINKING.md
OBJC-LOAD-AND-LINKING.md
 
 
README.md
README.md
 
 
RELEASE.md
RELEASE.md
 
 
SDK_HISTORY.md
SDK_HISTORY.md
 
 
SENTRYCRASH.md
SENTRYCRASH.md
 
 
SENTRYCRASH_IMPROVEMENT_PLAN.md
SENTRYCRASH_IMPROVEMENT_PLAN.md
 
 
SWIFT.md
SWIFT.md
 
 
TEST.md
TEST.md
 
 
VIEW_MASKING_STRATEGIES.md
VIEW_MASKING_STRATEGIES.md
 
 
disabling_tests_xcode_test_plan.png
disabling_tests_xcode_test_plan.png
 
 
fishhook-symbol-tables.png
fishhook-symbol-tables.png
 
 
xcode_test_plan_uicapture_playback.png
xcode_test_plan_uicapture_playback.png
 
 
xcode_test_plan_uicapture_settings.png
xcode_test_plan_uicapture_settings.png
 
 
xcode_tests_navigator_with_skipped_test.png
xcode_tests_navigator_with_skipped_test.png
 
 

README.md

Develop Documentation

This is a collection of documents that can help you develop for the SentrySDK.

  • ARCHITECTURE.md: the high-level concepts, features and organization of the codebase
  • SWIFT.md: how we handle the intricacies when mixing Swift and ObjC/++
  • TEST.md: unit testing, UI testing and static/runtime analysis
  • BUILD.md: how we configure and build our SDK deliverables
  • RELEASE.md: our release processes and best practices
  • OBJC-LOAD-AND-LINKING.md: how Objective-C +load interacts with build configurations and distribution formats
  • SDK_HISTORY.md: historical context and FAQ for the SDK
  • Language Trends Report: interactive chart of the repository's language breakdown over time, updated on every merge to main via GitHub Pages

GitHub Pages

We use GitHub Pages to host generated developer reports. The site is deployed automatically by the Analyze Language Trends workflow, which builds the report and pushes it via actions/upload-pages-artifact + actions/deploy-pages. Pages is configured to deploy from GitHub Actions (Settings > Pages > Source > "GitHub Actions"). Currently the only report hosted there is the language trends analysis; more reports can be added by extending the site preparation step in the workflow.