Skip to content

docs: add build-from-source manual, package targets, and cold-cache gate - #1041

Closed
c03rad0r wants to merge 1 commit into
mainfrom
docs/build-from-source
Closed

c03rad0r wants to merge 1 commit into
mainfrom
docs/build-from-source

Conversation

@c03rad0r

Copy link
Copy Markdown
Contributor

What

Add a tested, user-facing build-from-source manual and make the build
targets explicit.

  • docs/build-from-source.md — tag-vs-main, ready-made package links
    (feed releases + installer), CI-overhaul/reproducible-builds status, pinned
    toolchains, target table, cold-cache gate, package builds, artifact
    verification, and the Build fails on main: missing go.sum entry for go-nostr/nip19 (btcutil/bech32) #1036 go.sum troubleshooting.
  • make package-ipk — full .ipk via packaging/local-build-ipk.sh.
  • make package-apk — .apk via scripts/build-sdk-package.sh.
  • make manual-check / make cold-battery — executable manual checks in a
    fresh module cache.
  • Fix scripts/manual-build-check.sh cleanup (chmod -R u+w before rm -rf;
    the Go module cache is read-only, so the trap could turn a green battery into
    exit 1).
  • Link the manual from README.md, CONTRIBUTING.md,
    docs/release-process.md, and docs/reproducible-builds.md.

portal-build is documented as the prerequisite it is, not a package build.
packaging/build-ipk.sh remains the low-level packer and is not wrapped.

Why

Warm GOMODCACHE hides missing go.sum entries; cached CI stayed green while
a cold user build failed (#1036). The manual makes the tag/main distinction
explicit, and the cold-cache check is the interim gate until the CI lanes are
rebuilt. #1032 (merged as 4e55543) fixes the remaining two modules; the
v0.6.0 tag is clean and no v0.6.1 is needed.

Testing

  • Cold make go-battery on v0.6.0 (9364f2e) — PASS, 16 modules.
  • Cold make go-battery on main post-fix(modules): complete the go-nostr nip19 go.sum for the two remaining carriers #1032 — PASS, 18 modules. The prior
    cleanup-trap failure is fixed in this PR.
  • Full make manual-check with pinned Node/npm — run below on the PR branch.
  • make package-ipk ARCH=x86_64 — run below.
  • Ansible wrapper in tollgate-infrastructure-kit syntax-checks.

No tag or release is moved by this PR.

Add docs/build-from-source.md as the single user-facing build entry point:
tag-vs-main, feed/installer links for ready-made packages, the CI-overhaul and
reproducible-builds status, pinned toolchains, the target table, cold-cache
battery, package builds, and the #1036 go.sum troubleshooting.

Add make package-ipk (local-build-ipk.sh) and make package-apk
(build-sdk-package.sh) as the two shippable package targets. portal-build is
their prerequisite; the low-level build-ipk.sh packer is deliberately not
wrapped.

Fix manual-build-check.sh cleanup: the Go module cache is read-only, so
chmod -R u+w before rm -rf. Without this, a successful battery exited 1 in the
trap.

Link the manual from README, CONTRIBUTING and release-process; update the
reproducible-builds cross-link.
@c03rad0r
c03rad0r marked this pull request as ready for review October 21, 2026 14:59
@c03rad0r

Copy link
Copy Markdown
Contributor Author

Lets appologize that the build setup is messy at the moment and lets mention that all repos of github.com/OpenTollGate/ got rugged of CI by github.

https://github.com/OpenTollGate/tollgate-installer/blob/main/docs/install-runbook.md

we could link this installer and mention that we are working on reproducible builds and improving the CI pipeline.

@c03rad0r

Copy link
Copy Markdown
Contributor Author

Superseded by #1042. This PR's head ref stopped syncing after its first commit, so the SDK CVM fix and the build-setup/installer-runbook feedback commit could not be added here. #1042 carries the full tree (docs + package targets + CVM fix + changelog); no content is lost.

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.

1 participant