Skip to content

docs: correct Route 53, AliasMode and CI check details - #283

Open
tefraz wants to merge 1 commit into
dns-aid:mainfrom
triont:docs/accuracy-fixes
Open

tefraz wants to merge 1 commit into
dns-aid:mainfrom
triont:docs/accuracy-fixes

Conversation

@tefraz

@tefraz tefraz commented Oct 16, 2026

Copy link
Copy Markdown

Description

Five small corrections where the docs (and one code comment) disagree with what the code or Route 53 actually does. No behaviour changes.

File Was Now Evidence
README.md Integrations link described as "backend-specific setup notes" Describes what docs/integrations.md covers: agent frameworks, workflow platforms and AWS The page's sections; backend setup lives in docs/getting-started.md
docs/architecture.md Route 53 needs custom SVCB parameters in the generic keyNNNNN form Route 53 rejects keyNNNNN too, so dns-aid-core moves custom parameters to the TXT record as dnsaid_keyNNNNN=value Route 53 returned InvalidChangeBatch: [SVCB does not support undefined parameters.] for a key65402 value (details in #247); demotion is base.py:317
docs/getting-started.md "Zone not found": set AWS_DEFAULT_REGION=us-east-1 Check the AWS account that owns the zone Route 53 is global, and the backend reads AWS_REGION, not AWS_DEFAULT_REGION (route53.py:77)
src/dns_aid/backends/base.py Comment: walkable AliasMode is published by default Off by default; opt in with publish_walkable_alias=True or --walkable models.py:722 (default=False), publisher.py:112, CLI help "Off by default"
CONTRIBUTING.md 8 required checks 9, adding the missing Mock Integration Tests row The main-protection ruleset lists 9 required status checks

The base.py change is to a comment only.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)

Checklist

  • My code follows the project's code style
  • I have added tests that prove my fix is effective or my feature works (not applicable: docs and a comment only)
  • All new and existing tests pass (pytest)
  • I have run ruff check and ruff format --check with no errors
  • I have run mypy src/ with no errors
  • I have updated documentation as needed
  • My commits include a Signed-off-by line (DCO)

Run locally on the branch: unit tests on Python 3.11, 3.12 and 3.13 (2893 passed, 2 skipped, coverage 92.96%), mock integration tests (30 passed), ruff, mypy and Bandit all clean.

Dependency Audit will fail, unrelated to this PR. pip-audit on current main reports vulnerabilities in pyjwt 2.13.0 and mcp 1.28.1, and the Dependency Audit job has been failing on other PRs since at least 15 October. I've left that alone here so this PR stays docs-only.

Related Issues

Relates to #247 (the Route 53 keyNNNNN rejection was found while confirming it).


I used Claude Code to help find and verify these and to draft this PR.

- README: docs/integrations.md covers agent frameworks, workflow
  platforms and AWS, not backend setup (that is in getting-started.md).
- architecture.md: Route 53 rejects the RFC 9460 generic keyNNNNN form
  too ("InvalidChangeBatch: SVCB does not support undefined
  parameters"). Describe what the code does instead: custom parameters
  move to the TXT record as dnsaid_keyNNNNN=value (base.py).
- getting-started.md: the "Zone not found" tip suggested setting
  AWS_DEFAULT_REGION. Route 53 is global, and the backend reads
  AWS_REGION (route53.py:77), so point at the AWS account instead.
- base.py: the comment said the walkable AliasMode record is published
  by default. It is off by default (models.py, publisher.py, the CLI's
  --walkable); fix the comment only, no code change.
- CONTRIBUTING.md: the main-protection ruleset requires 9 checks; add
  the missing Mock Integration Tests row.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Tim Fraser <124688+tefraz@users.noreply.github.com>
@tefraz
tefraz requested a review from iracic82 as a code owner October 16, 2026 23:12

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant