docs: note how the module resolves and verify it in release-check
Test / test (push) Successful in 1m40s

Assisted-by: GLM 5.3 Flash
This commit is contained in:
2026-09-22 01:31:37 +02:00
parent 3406955654
commit ebaca18093
2 changed files with 7 additions and 0 deletions
+5
View File
@@ -40,6 +40,11 @@ go get sourcedock.dev/petrbalvin/interpres/v2
Requires Go 1.27.1 or newer. The module imports only the standard library.
The module is public and resolves through proxy.golang.org and sum.golang.org
like any other; no GOPROXY or GOPRIVATE setup is needed to fetch it. A machine
that sets `GOPRIVATE=sourcedock.dev` fetches directly from the forge instead,
which skips the proxy and the checksum database.
## Quick start
```sh
+2
View File
@@ -134,6 +134,8 @@ release-check version:
print qq{branch, tree, sync and changelog verified; running the gates\n};
system(qw{just gates}) == 0 or die qq{release-check: the gates failed\n};
print qq{release-check: ready to release $version\n};
print qq{after tagging, verify the /v2 module resolves through the proxy:\n};
print qq{ cd \$(mktemp -d) && go mod init t && GOPRIVATE= GOPROXY=https://proxy.golang.org go get sourcedock.dev/petrbalvin/interpres/v2\@$version\n};
# Compares the toml-test counts the documentation names with the live suite run; not standard, it exists because a corpus change used to be corrected by hand.
docs-drift: