Skip to content

Godot: Add page for Android support #14270

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.

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

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Conversation

limbonaut
Copy link
Collaborator

@limbonaut limbonaut commented Jul 7, 2025

DESCRIBE YOUR PR

Add a page with instructions for Android exports in the Godot SDK. Android support is added starting with 1.0-alpha.1.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Copy link

vercel bot commented Jul 7, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 8, 2025 0:03am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Jul 8, 2025 0:03am

@codeowner-assignment codeowner-assignment bot requested a review from a team July 7, 2025 11:44
Copy link

codecov bot commented Jul 7, 2025

Bundle Report

Changes will increase total bundle size by 2.64kB (0.01%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 11.8MB 2.64kB (0.02%) ⬆️
sentry-docs-client-array-push 9.8MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.64MB -0.0%
../instrumentation.js -3 bytes 973.36kB -0.0%
9523.js -3 bytes 949.31kB -0.0%
../app/[[...path]]/page.js.nft.json 884 bytes 691.53kB 0.13%
../app/platform-redirect/page.js.nft.json 884 bytes 691.44kB 0.13%
../app/sitemap.xml/route.js.nft.json 884 bytes 689.41kB 0.13%
view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 873.24kB -0.0%
static/chunks/7750-*.js -3 bytes 415.85kB -0.0%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
server/middleware-*.js -5.55kB 1.0kB -84.74%
static/2BTa9ScDORHjbPE16z3Pr/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/2BTa9ScDORHjbPE16z3Pr/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/lFf0jbHWvetMuGIAkEHVT/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/lFf0jbHWvetMuGIAkEHVT/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

Copy link
Member

Choose a reason for hiding this comment

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

I think it's odd to have this page be top level while desktop isn't. when we add iOS and Web would those also get dedicated pages? we don't do this on other game engine sdks usually.

Copy link
Collaborator Author

@limbonaut limbonaut Jul 7, 2025

Choose a reason for hiding this comment

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

So where should we place it if not top-level? Don't think we want to clutter the landing page.

UPDATE:
Perhaps, this belongs in configuration?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Moved to configuration section, removed features, and streamlined the rest.


Setting up Sentry for Android exports requires using Godot's Gradle build system. The Sentry SDK automatically integrates with your Gradle project, but you need to set up the Android build template first.

### Prerequisites
Copy link
Member

Choose a reason for hiding this comment

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

This seems like On-boarding instructions. But it involves general Godot Android on-boarding; right? so if the dev already has the game running on Android, are all these step needed?

We have on-boarding stuff on the landing page. ideally this goes there. maybe with the tab control to pick platform target.

Copy link
Collaborator Author

@limbonaut limbonaut Jul 7, 2025

Choose a reason for hiding this comment

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

Users MUST set up Gradle build system. Normally, this is not required. You can export Godot projects to Android without involving Gradle build.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

so if the dev already has the game running on Android, are all these step needed?

Not all of these steps are needed, but some are absolutely required. I think it's better to be explicit, in case users are coming fresh without any export set up initially. But let me know if you think we shouldn't go extra mile here.

@codeowner-assignment codeowner-assignment bot requested a review from a team July 7, 2025 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants