docs: add pkg/syncutil README and register dependency in cli/workflow specs#33325
Merged
Conversation
4 tasks
Agent-Logs-Url: https://github.com/github/gh-aw/sessions/db670686-3855-4da4-a456-cdf483b377b8 Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
…cies Agent-Logs-Url: https://github.com/github/gh-aw/sessions/db670686-3855-4da4-a456-cdf483b377b8 Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add README.md for pkg/syncutil specification
docs: add pkg/syncutil README and register dependency in cli/workflow specs
May 19, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a missing README.md specification for pkg/syncutil (the only package in the repo previously undocumented) and registers syncutil in the internal-dependencies tables of pkg/cli and pkg/workflow.
Changes:
- New
pkg/syncutil/README.mddocumentingOnceLoader[T](Get/Reset, mutex semantics, error caching, zero-value readiness). - Adds
syncutilrow to the internal-dependencies tables inpkg/cli/README.mdandpkg/workflow/README.md. - An unrelated edit in
.github/workflows/smoke-otel-backends.lock.ymlswaps the source secret for theDD_APPLICATION_KEYHTTP header.
Show a summary per file
| File | Description |
|---|---|
| pkg/syncutil/README.md | New package specification covering OnceLoader[T] API, design notes, and lack of deps. |
| pkg/cli/README.md | Registers pkg/syncutil as an internal dependency (repo slug caching). |
| pkg/workflow/README.md | Registers pkg/syncutil as an internal dependency (repository feature caching). |
| .github/workflows/smoke-otel-backends.lock.yml | Changes the Datadog DD_APPLICATION_KEY header value source from ${DD_APPLICATION_KEY} to ${DD_APP_KEY} — appears unrelated to the PR's stated purpose. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 4/4 changed files
- Comments generated: 1
| "headers": { | ||
| "DD_API_KEY": "\${DD_API_KEY}", | ||
| "DD_APPLICATION_KEY": "\${DD_APPLICATION_KEY}", | ||
| "DD_APPLICATION_KEY": "\${DD_APP_KEY}", |
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.
pkg/syncutilwas the only package among 26 without a specification, leavingpkg/cliandpkg/workflowunable to document their dependency on it.Changes
pkg/syncutil/README.md(new) — documentsOnceLoader[T]: its mutex-based once-semantics, error caching behaviour, zero-value readiness, andResetcontractpkg/cli/README.md— addssyncutilto the internal dependencies table (used for repository slug caching inrepo.go)pkg/workflow/README.md— addssyncutilto the internal dependencies table (used for repository feature caching inrepository_features_validation.go)OnceLoader in brief