docs: Fix Heroku deploy button configuration#889
Conversation
|
I will reformat the title to use the proper commit message syntax. |
parse-github-assistant
Bot
changed the title
|
🚀 Thanks for opening this pull request! We appreciate your effort in improving the project. Please let us know once your pull request is ready for review. Tip
Note Please respond to review comments from AI agents just like you would to comments from a human reviewer. Let the reviewer resolve their own comments, unless they have reviewed and accepted your commit, or agreed with your explanation for why the feedback was incorrect. Caution Pull requests must be written using an AI agent with human supervision. Pull requests written entirely by a human will likely be rejected, because of lower code quality, higher review effort and the higher risk of introducing bugs. Please note that AI review comments on this pull request alone do not satisfy this requirement. Our CI and AI review are safeguards, not development tools. If many issues are flagged, rethink your development approach. Invest more effort in planning and design rather than using review cycles to fix low-quality code. |
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the Heroku deployment metadata and docs to use an externally-provided MongoDB connection string (instead of the deprecated mLab add-on) and to reference the parse-community repository.
Changes:
- Switch Heroku deploy metadata to require
DATABASE_URIand remove themongolabadd-on dependency. - Update Heroku docs/deploy button to use the repo template and instruct users to provision MongoDB (e.g., Atlas).
- Modernize Google App Engine deployment instructions (
gcloud app deploy) and replace mLab reference.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| app.json | Updates repository URL, adds required DATABASE_URI, removes mLab add-on, updates default SERVER_URL scheme. |
| README.md | Updates Heroku deploy flow to external MongoDB + DATABASE_URI, refreshes Google App Engine MongoDB + deploy guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * By default it will use a path of /parse for the API routes. To change this, or use older client SDKs, run `heroku config:set PARSE_MOUNT=/1` | ||
| * Configure the public server URL: `heroku config:set SERVER_URL=https://YourAppName.herokuapp.com/parse` |
There was a problem hiding this comment.
Addressed in the same commit — the README now adds an explicit heroku config:set SERVER_URL=... step right after the PARSE_MOUNT step, with the /parse and /1 examples side by side so the two stay in sync.
| * Use the [mLab addon](https://elements.heroku.com/addons/mongolab): `heroku addons:create mongolab:sandbox --app YourAppName` | ||
| * Log in with the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) and create an app: `heroku create` | ||
| * Create a MongoDB database, for example with [MongoDB Atlas](https://www.mongodb.com/atlas/database), and copy its connection string | ||
| * Configure the database connection: `heroku config:set DATABASE_URI='<replace with MongoDB connection string>'` |
There was a problem hiding this comment.
Addressed in the same commit — the README step for DATABASE_URI doesn't prescribe single quotes; it now says "quote or escape special characters as required by your shell", which leaves Windows / PowerShell users free to use their own syntax.
| "value": "myMasterKey" | ||
| }, | ||
| "DATABASE_URI": { | ||
| "description": "MongoDB connection string for this Parse Server deployment, for example a MongoDB Atlas connection string.", |
There was a problem hiding this comment.
Addressed in the same commit — app.json's DATABASE_URI description now reads "Keep this secret because it can contain credentials.", matching the existing MASTER_KEY framing.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe PR updates deployment configuration and documentation to fix non-functional deployment buttons and modernize the cloud provider setup processes. Changes include updating the app.json repository reference, adding required DATABASE_URI configuration, switching from mLab to MongoDB Atlas across Heroku and Google App Engine instructions, and updating deployment tooling references to current CLI commands. ChangesDeployment Documentation and Configuration
🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 6 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (6 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 OpenGrep (1.21.0)OpenGrep fatal error (exit code 2): [00.21][ERROR]: Error: exception Unix_error: No such file or directory stat app.json 🔧 Checkov (3.2.529)app.json2026-05-21 11:21:35,596 [MainThread ] [ERROR] Template file not found: app.json ... [truncated 2512 characters] ... 35,712 [MainThread ] [WARNI] Secret scanning: could not process file app.json Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
app.json (2)
20-23: ⚡ Quick winConsider adding a DATABASE_URI format example.
The description mentions "for example a MongoDB Atlas connection string" but doesn't provide an actual format example. Consider adding a placeholder example to help users understand the expected format.
💡 Proposed enhancement
"DATABASE_URI": { - "description": "MongoDB connection string for this Parse Server deployment, for example a MongoDB Atlas connection string.", + "description": "MongoDB connection string for this Parse Server deployment, for example a MongoDB Atlas connection string (mongodb+srv://user:pass@cluster.mongodb.net/dbname).", "required": true },🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@app.json` around lines 20 - 23, Add a clear placeholder example for the DATABASE_URI field in app.json so users know the expected format; update the "DATABASE_URI" key description to include a sample MongoDB Atlas connection string (e.g. mongodb+srv://<username>:<password>@<cluster>.mongodb.net/<dbname>?retryWrites=true&w=majority) and mark it as a placeholder to be replaced, keeping the existing note about allowed alternatives.
4-4: Repository URL is correct and reachable
app.jsonsetsrepositorytohttps://github.com/parse-community/parse-server-example(line 4), and it returns HTTP 200 publicly.DATABASE_URI(lines 20-23) is already markedrequiredand the description clarifies it should be a MongoDB connection string (e.g., Atlas).SERVER_URL(lines 24-27) uses ayourappnameplaceholder, but the description explicitly instructs replacing it with the app name +PARSE_MOUNT; optionally tighten wording to avoid confusion.- Consider confirming
image: "heroku/nodejs"(line 29) is still the intended/current Heroku buildpack/image for this deployment.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@app.json` at line 4, Confirm repository value remains as is; tighten the SERVER_URL description to explicitly instruct replacing the placeholder with your app's full public URL including PARSE_MOUNT (reference key SERVER_URL) to avoid ambiguity, clarify that DATABASE_URI is required and should be a valid MongoDB connection string (reference key DATABASE_URI) if you want to make wording stricter, and verify whether the Heroku image key value "heroku/nodejs" (reference key image) is still the intended/current build image and update it if Heroku's recommended stack has changed; no other changes needed to the repository field.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@app.json`:
- Around line 20-23: Add a clear placeholder example for the DATABASE_URI field
in app.json so users know the expected format; update the "DATABASE_URI" key
description to include a sample MongoDB Atlas connection string (e.g.
mongodb+srv://<username>:<password>@<cluster>.mongodb.net/<dbname>?retryWrites=true&w=majority)
and mark it as a placeholder to be replaced, keeping the existing note about
allowed alternatives.
- Line 4: Confirm repository value remains as is; tighten the SERVER_URL
description to explicitly instruct replacing the placeholder with your app's
full public URL including PARSE_MOUNT (reference key SERVER_URL) to avoid
ambiguity, clarify that DATABASE_URI is required and should be a valid MongoDB
connection string (reference key DATABASE_URI) if you want to make wording
stricter, and verify whether the Heroku image key value "heroku/nodejs"
(reference key image) is still the intended/current build image and update it if
Heroku's recommended stack has changed; no other changes needed to the
repository field.
Summary
Fixes #404
Verification
app.jsongit diff --checkSummary by CodeRabbit
Documentation
Chores