Skip to content

docs: add pkg/syncutil README and register dependency in cli/workflow specs#33325

Merged
pelikhan merged 3 commits into
mainfrom
copilot/add-readme-to-syncutil
May 19, 2026
Merged

docs: add pkg/syncutil README and register dependency in cli/workflow specs#33325
pelikhan merged 3 commits into
mainfrom
copilot/add-readme-to-syncutil

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 19, 2026

pkg/syncutil was the only package among 26 without a specification, leaving pkg/cli and pkg/workflow unable to document their dependency on it.

Changes

  • pkg/syncutil/README.md (new) — documents OnceLoader[T]: its mutex-based once-semantics, error caching behaviour, zero-value readiness, and Reset contract

  • pkg/cli/README.md — adds syncutil to the internal dependencies table (used for repository slug caching in repo.go)

  • pkg/workflow/README.md — adds syncutil to the internal dependencies table (used for repository feature caching in repository_features_validation.go)

OnceLoader in brief

var cache syncutil.OnceLoader[string]

// loader called exactly once; subsequent calls return cached (value, err)
slug, err := cache.Get(func() (string, error) {
    return fetchRepoSlugFromGitHub()
})

// Re-arm for next Get call
cache.Reset()

Copilot AI linked an issue May 19, 2026 that may be closed by this pull request
4 tasks
Copilot AI and others added 2 commits May 19, 2026 14:31
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
Copilot AI requested a review from gh-aw-bot May 19, 2026 14:37
@pelikhan pelikhan marked this pull request as ready for review May 19, 2026 15:21
Copilot AI review requested due to automatic review settings May 19, 2026 15:21
@pelikhan pelikhan merged commit 75ffa26 into main May 19, 2026
1 check passed
@pelikhan pelikhan deleted the copilot/add-readme-to-syncutil branch May 19, 2026 15:22
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.md documenting OnceLoader[T] (Get/Reset, mutex semantics, error caching, zero-value readiness).
  • Adds syncutil row to the internal-dependencies tables in pkg/cli/README.md and pkg/workflow/README.md.
  • An unrelated edit in .github/workflows/smoke-otel-backends.lock.yml swaps the source secret for the DD_APPLICATION_KEY HTTP 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}",
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.

Specification Audit — 2026-05-19 — 1 missing spec

4 participants