docs: add AGENTS.md with Heroku and OAuth operational gotchas#3590
Open
jstvz wants to merge 1 commit into
Open
docs: add AGENTS.md with Heroku and OAuth operational gotchas#3590jstvz wants to merge 1 commit into
jstvz wants to merge 1 commit into
Conversation
Captures non-obvious behaviors that have burned operators on this repo, so future agent sessions and human teammates can pick up context without rediscovering them. - heroku config:set is async via release-phase; sentinel-testing CONNECTED_APP_CLIENT_KEY can take OAuth offline. - New Heroku app hostnames get a 12-char suffix; callback URLs and DJANGO_ALLOWED_HOSTS must match the suffixed hostname. - Salesforce Connected App callback validation is whole-list; a stale entry can block saves.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
AGENTS.mdat repo root, consumed by AI coding agents (Claude Code, Cursor, Copilot Workspace) and humans alike at session start.Why
This week, two of the gotchas listed in the file caused real friction during the Phase 0 / dev-branch workflow operations:
heroku config:setagainstmetadeploy-stgappeared to be a no-op becauseconfig:getreturned the prior live value while three releases queued behind a slow release-phase. The lesson: validate viaheroku releases, notheroku config:get.*.herokuapp.comhostname, which broke the Connected App callback URL set against the un-suffixed name.A teammate is about to start work on a11y bugs in this repo and will benefit from having these gotchas surfaced up front rather than embedded in slack threads or commit history.
Scope
CONTRIBUTING.mdanddocs/as canonical for branching and runtime details. Once PR Switch Heroku build to container runtime; pin python:3.12-slim-bookworm #3588 lands, a follow-up will fold the container-runtime + release-phase content intodocs/heroku-container-runtime.mdand trim AGENTS.md to point at it.Test plan
AGENTS.mdrenders correctly in GitHub.