docs: support anonymous public-source demo builds - #1
Open
dzdidi wants to merge 2 commits into
Open
Conversation
Signed-off-by: dzdidi <dzdidi@protonmail.com>
There was a problem hiding this comment.
Pull request overview
Updates the local Locks demo documentation to support reproducible “anonymous” builds using pinned public Git BuildKit contexts, while keeping local worktrees as an explicit override path.
Changes:
- Clarifies
Dockerfile.local/demo-image behavior and terminology inREADME.mdandDockerfile.local. - Updates implementation/design plan documents to reference public, pinned upstream sources (Locks ADR 0020 and Paykit companion-claim docs).
- Expands
docs/local-locks-demo.mdwith a copy/paste build command for public pinned sources and keeps the local-worktree override workflow documented.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Clarifies what the local demo image build consumes and produces. |
| docs/plans/0004-local-locks-compose-integration.md | Replaces sibling-worktree references with public pinned upstream links and updates the demo build command accordingly. |
| docs/plans/0002-receiver-only-prototype-implementation.md | Updates authoritative requirement links to public pinned Locks sources. |
| docs/plans/0001-receiver-only-prototype-design.md | Updates authoritative Locks contract references and adjusts the referenced Locks revision. |
| docs/local-locks-demo.md | Adds “public pinned sources” build instructions and tightens wording around local-worktree overrides and runtime contract. |
| Dockerfile.local | Updates comments to reflect that named build contexts can come from any calling build/Compose project (not only sibling Locks). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: dzdidi <5725222+dzdidi@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.
Suppressed comments (1)
docs/plans/0002-receiver-only-prototype-implementation.md:13
- The Tech Stack line still pins
paykit-sdk/paykit-libtopaykit-rscommit81fd0e5…, but this repo’sCargo.tomlnow pins both dependencies to52a8529…. This plan is intended to be executable against the current workspace pins, so the hash here should match to avoid sending readers to the wrong upstream snapshot.
**Tech Stack:** Rust edition 2024 (MSRV 1.91.1), Tokio, Axum, SQLx/PostgreSQL, `paykit-sdk`/`paykit-lib` pinned to inspected `paykit-rs` commit `52a852995bfc457b78d32f5a45f6741766a89bba`, XChaCha20-Poly1305, HKDF-SHA256, Ed25519, Electrum client.
**Authoritative requirements:**
- `docs/plans/0001-receiver-only-prototype-design.md`
- [Locks ADR 0020](https://github.com/pubky/locks/blob/df5ea1b6d8dcdec3a9b5a915c3f57bca69d75c8a/docs/ADRs/0020-locks-paykit-v1-integration-boundary.md)
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.
No description provided.