Skip to content

docs: use distinct binary name for optimized builds and clarify release parity#2105

Merged
devantler merged 2 commits intodocs/document-build-optimizations-759e3b5e17a2f37dfrom
copilot/sub-pr-2103
Feb 8, 2026
Merged

docs: use distinct binary name for optimized builds and clarify release parity#2105
devantler merged 2 commits intodocs/document-build-optimizations-759e3b5e17a2f37dfrom
copilot/sub-pr-2103

Conversation

Copy link
Contributor

Copilot AI commented Feb 8, 2026

Addresses review feedback on build optimization documentation to prevent confusion about development vs. release builds and avoid overwriting binaries.

Changes

  • Changed output binary name: ksailksail-optimized for the optimized build command, preventing developers from accidentally overwriting their debug-enabled binary and enabling side-by-side comparison
  • Clarified wording: "matches release artifacts" → "uses the same -ldflags as release builds" to accurately reflect that the example omits CGO_ENABLED=0 (which is set in actual release builds via GoReleaser)
  • Applied consistently across both CONTRIBUTING.md and .github/copilot-instructions.md

This allows contributors to experiment with both build variants without losing their development binary and sets accurate expectations about what the command produces.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: devantler <26203420+devantler@users.noreply.github.com>
Copilot AI changed the title [WIP] Document build optimization flags in contributor guide docs: use distinct binary name for optimized builds and clarify release parity Feb 8, 2026
Copilot AI requested a review from devantler February 8, 2026 23:06
@devantler devantler marked this pull request as ready for review February 8, 2026 23:09
@devantler devantler merged commit 38df27d into docs/document-build-optimizations-759e3b5e17a2f37d Feb 8, 2026
@github-project-automation github-project-automation bot moved this from 🏃🏻‍♂️ In Progress to ✅ Done in 🌊 Project Board Feb 8, 2026
@devantler devantler deleted the copilot/sub-pr-2103 branch February 8, 2026 23:09
github-merge-queue bot pushed a commit that referenced this pull request Feb 11, 2026
* docs: document build optimization flags in contributor guide

Add documentation for -ldflags="-s -w" build optimization that reduces
binary size by ~28% (302MB → 217MB). This helps contributors understand
the difference between development builds and release artifacts.

Changes:
- CONTRIBUTING.md: Add production build command with optimization flags
- .github/copilot-instructions.md: Add optimization note to build section

Relates to: #2095

* Update CONTRIBUTING.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Nikolai Emil Damm <ned@devantler.tech>

* Update .github/copilot-instructions.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Nikolai Emil Damm <ned@devantler.tech>

* Update .github/copilot-instructions.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Nikolai Emil Damm <ned@devantler.tech>

* docs: use distinct binary name for optimized builds and clarify release parity (#2105)

* Initial plan

* docs: use distinct binary name for optimized builds and clarify wording

Co-authored-by: devantler <26203420+devantler@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: devantler <26203420+devantler@users.noreply.github.com>

* docs: include specific benchmark numbers in build optimization note (#2110)

---------

Signed-off-by: Nikolai Emil Damm <ned@devantler.tech>
Co-authored-by: Update Docs Bot <docs-bot@devantler-tech.com>
Co-authored-by: Nikolai Emil Damm <ned@devantler.tech>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: devantler <26203420+devantler@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

2 participants

Comments