Loading
Commits on Source 3
-
Matt Cockayne authored
-
Matt Cockayne authored
Found by a documentation audit against the source, run after a sibling audit of the forge module found twenty drift findings. Four shapes repeat across every adapter, and are fixed the same way in each: - The "Use it" snippet called factory(source, cfg). `source` is undefined — it is the name of the type the Endpoint cut replaced — and the call is missing ctx entirely. ProviderFactory is func(ctx, ep forge.Endpoint, cfg forge.Config, opts ...forge.Option), so the snippet has not compiled since that cut. - ReleaseSource.Host appeared in the Enterprise instructions. The type does not exist; the field is Endpoint.Host. - key.go's UploadKey godoc pointed at [Settings.Auth]. There is no Auth field, so pkg.go.dev rendered a link to nothing. It is Settings.Credential. - discovery.go and issues.go cited specs by a docs/development/specs/<date>.md path. forge moved every spec to the wiki on 2026-08-06 and those paths have not resolved since; they now cite the wiki pages by number. Two more are specific to this module, and both understated what it does. The README carried its own capability table listing three capabilities. This provider implements nine: it gained Repositories, Contents, Sites, Issues, IssueFiler and Snippets after that table was written, and none was added to it. The same section then stated that file contents is "not here" while Contents.GetFile downloads exactly that. The table is not replaced with a corrected one. Adapter documentation belongs in core, and the cross-provider capability matrix already lives there — a per-module copy is what drifted, and a corrected copy would drift again. The README now names this provider's capabilities in one sentence and points at the matrix. doc.go had never been touched since the module was extracted. It described construction through a [GitHubClient] interface using [ClientSettings] and [ClientSettingsFromConfig] — three identifiers that do not exist, having been renamed to Settings and SettingsFromConfig — and claimed a pull-request capability the module has never had. Its own client.go says the opposite. -
Matt Cockayne authored