docs: fix stale comments - #87
Merged
Merged
Conversation
Signed-off-by: James Hateley <jhateley@godaddy.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates internal RA documentation comments to match the current lifecycle/event model, removing references to retired event types and clarifying when terminal lifecycle events are emitted.
Changes:
- Update
VerifyDNS,RevokeInput, andVerifyInputcomments to referenceAGENT_REGISTERED/AGENT_REVOKEDand the terminal-only emission model. - Update helper documentation to reflect that metadata hashes are carried on the
AGENT_REGISTEREDattestation. - Clarify registration handler commentary about when production DNS records are surfaced (and where they appear in the API).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| internal/ra/service/lifecycle.go | Fixes stale lifecycle comments referencing retired event types and incorrect lane behavior. |
| internal/ra/service/helpers.go | Updates helper doc to reference the correct attestation/event type. |
| internal/ra/handler/registration.go | Refines handler docs about when production DNS records become available to clients. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+255
to
+258
| // Production DNS records (TRUST / BADGE / DISCOVERY / TLSA) | ||
| // don't appear until after verify-acme issues certs — the TLSA | ||
| // fingerprint can't exist before the server cert does. | ||
| // The records surface on GET agent detail via registrationPending.dnsRecords |
csnitker-godaddy
approved these changes
Jul 21, 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.
Related issue
Fixes #60
Summary
Corrects three inaccurate comments in internal/ra/service/lifecycle.go that named event types the code doesn't emit:
differs); DOMAIN_VALIDATION is a challenge purpose, not an event type.
Comments only — no behavior change.
Testing
No tests updated - docs fix only
AI assistance
Checklist
git commit -s) certifying the DCO