Skip to content

docs: fix stale comments - #87

Merged
csnitker-godaddy merged 1 commit into
mainfrom
docs/fix-stale-comments
Jul 21, 2026
Merged

docs: fix stale comments#87
csnitker-godaddy merged 1 commit into
mainfrom
docs/fix-stale-comments

Conversation

@jhateley-godaddy

Copy link
Copy Markdown
Collaborator

Related issue

Fixes #60

Summary

Corrects three inaccurate comments in internal/ra/service/lifecycle.go that named event types the code doesn't emit:

  • RegisterServerCert doc said it emits AGENT_ACTIVE — it emits AGENT_REGISTERED.
  • RevokeInput doc referenced AGENT_REVOCATION — the actual token is AGENT_REVOKED.
  • VerifyInput doc claimed V2 emits AGENT_ACTIVE and referenced a non-existent intermediate DOMAIN_VALIDATION event type. Both lanes emit AGENT_REGISTERED at the ACTIVE transition (only the attestation shape
    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

  • The PR title follows Conventional Commits — release notes are generated from it
  • Tests cover the change
  • The linked issue above uses a closing keyword
  • Every commit is signed off (git commit -s) certifying the DCO

Signed-off-by: James Hateley <jhateley@godaddy.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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, and VerifyInput comments to reference AGENT_REGISTERED / AGENT_REVOKED and the terminal-only emission model.
  • Update helper documentation to reflect that metadata hashes are carried on the AGENT_REGISTERED attestation.
  • 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
csnitker-godaddy added this pull request to the merge queue Jul 21, 2026
Merged via the queue into main with commit 9383881 Jul 21, 2026
4 checks passed
@csnitker-godaddy
csnitker-godaddy deleted the docs/fix-stale-comments branch July 21, 2026 15:49
@github-project-automation github-project-automation Bot moved this from Triage to Done in Agent Name Service Jul 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

chore: stale comments still describe the retired AGENT_ACTIVE/AGENT_REVOCATION event model

3 participants