docs: Add ADR 0002 for API enhancement and drift detection#6590
Merged
chenrui333 merged 12 commits intoJun 27, 2026
Conversation
Splits the architecture decision record out of runatlantis#6360 so it can be reviewed and merged independently from the implementation. Signed-off-by: PePe Amengual <2208324+jamengual@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new Architecture Decision Record (ADR 0002) documenting the design rationale for planned Atlantis API response modernization and drift detection/remediation endpoints (split out for independent review from the implementation work referenced in #6360).
Changes:
- Introduces ADR 0002 describing phased API enhancements (error serialization, non-PR workflows) and drift detection/remediation endpoint design.
- Captures historical context from prior PR attempts and proposes an implementation plan and consequences analysis.
jamengual
added a commit
to jamengual/atlantis
that referenced
this pull request
Jun 26, 2026
The drift detection ADR is moved to a separate PR (runatlantis#6590) so it can be reviewed and merged independently from this implementation. Signed-off-by: PePe Amengual <2208324+jamengual@users.noreply.github.com>
7 tasks
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: PePe Amengual <2208324+jamengual@users.noreply.github.com>
Preserve full plan drift stats by requiring reuse of the existing plan stats parser, and expand the VCS remediation plan to cover every client implementation plus generated mocks. Assisted-by: OpenAI <noreply@openai.com> Signed-off-by: Rui Chen <rui@chenrui.dev>
Make the drift parsing and VCS remediation examples compile as written, and key drift status storage by path and workspace so unnamed Atlantis projects do not collide. Assisted-by: OpenAI <noreply@openai.com> Signed-off-by: Rui Chen <rui@chenrui.dev>
Make drift status storage the required data source for the status endpoint, and require remediation to create a real branch diff before opening a PR or MR. Assisted-by: OpenAI <noreply@openai.com> Signed-off-by: Rui Chen <rui@chenrui.dev>
Require VCS repository identity in drift status queries and storage keys, and update the provider implementation snippets to match the current client types and GitLab label options. Assisted-by: OpenAI <noreply@openai.com> Signed-off-by: Rui Chen <rui@chenrui.dev>
2 tasks
Use the canonical VCS type in drift status examples, update the GitHub branch creation snippet for go-github v88, and document GitLab draft MR title handling. Assisted-by: OpenAI <noreply@openai.com> Signed-off-by: Rui Chen <rui@chenrui.dev>
Keep drift status models in one package, remove derived repo IDs from the lookup key, and document how non-PR API applies seed dependency status. Assisted-by: OpenAI <noreply@openai.com> Signed-off-by: Rui Chen <rui@chenrui.dev>
Member
|
Require API token authentication for drift endpoints, make drift status lookups ref-scoped, and document API apply dependency status updates for non-PR runs. Assisted-by: OpenAI <noreply@openai.com> Signed-off-by: Rui Chen <rui@chenrui.dev>
Document force-unlock IDs as query/body/catch-all values so slash-containing Atlantis lock keys are preserved when calling Locker.Unlock. Assisted-by: OpenAI <noreply@openai.com> Signed-off-by: Rui Chen <rui@chenrui.dev>
chenrui333
approved these changes
Jun 27, 2026
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
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
Adds the Architecture Decision Record ADR 0002: API Enhancement and Drift Detection, split out of #6360 so the design can be reviewed and merged independently from the implementation.
This is docs-only — no code changes. The ADR documents the rationale behind the modernized API response framework and the drift detection/remediation endpoints implemented in #6360.
Test plan