Repository navigation
Document v0.0.3 hostname home-host contract - #31
Merged
Merged
Conversation
Omitted hostname binds to the home host; producers write only github.com (for github.com-bound pins on data-residency instances) and never *.ghe.com. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
🟢 Approval recommended
The documentation changes are consistent across the README, schema, generated schema, and Go API.
0 open findings
What changed in this PR
Documents the v0.0.3 home-host semantics without changing validation behavior.
Changes:
- Clarifies hostname omission, production, and migration rules.
- Synchronizes schema and Go API documentation.
- Updates examples to omit home-host hostname values.
| File | Description |
|---|---|
README.md |
Documents the hostname contract and migration rules. |
schema/lockfile-v0.0.3.json |
Clarifies hostname schema semantics. |
go/pkg/lockfile/schema_gen.go |
Regenerates the embedded schema. |
go/pkg/lockfile/lockfile.go |
Updates examples and field documentation. |
Files not reviewed (1)
- go/pkg/lockfile/schema_gen.go: Generated file
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Why
#29 said hostname-aware producers record the hostname on every dependency. That is no longer the contract. An omitted
hostnamenow means the dependency belongs to the home host, so producers only writehostnamefor pins bound to github.com while running on a GHE.com data-residency instance.What changed
hostnamecontract:github.com, and never write a*.ghe.comhostname.github.comand rejects anything else.github.comon every dependency.hostnamedescription inschema/lockfile-v0.0.3.jsonand the generatedschema_gen.gonow carry the same meaning.Actiondocs are now per-field comments, and theFileexample no longer showshostname.There is no behavior change. Hostname syntax validation is unchanged.