docs: clarify Go toolchain version#599
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #599 +/- ##
==========================================
- Coverage 67.43% 67.38% -0.06%
==========================================
Files 53 53
Lines 5644 5644
==========================================
- Hits 3806 3803 -3
- Misses 1612 1614 +2
- Partials 226 227 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Updates project documentation to explain the Go versioning split between the go language directive (go 1.26) and the pinned patch-level toolchain directive (toolchain go1.26.2), aiming to keep toolchain references consistent across the repo’s docs and build surfaces.
Changes:
- Expand README build instructions to explain
go 1.26vstoolchain go1.26.2. - Add the same toolchain explanation to the installation guide’s “Building from Source” section.
- Add development guide guidance to keep
.tool-versions, CI, Docker images, and docs aligned with the pinned toolchain.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Clarifies the required/pinned Go toolchain and the go vs toolchain split in the build-from-source section. |
| docs/installation.md | Adds a toolchain explanation for source builds to align with the repo’s Go module directives. |
| docs/development.md | Documents the go.mod versioning split and calls out keeping tooling references aligned across the project. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Building from Source | ||
|
|
||
| Go 1.26.2 is required to build confd. | ||
| Go 1.26.2 is required to build confd. The module uses `go 1.26` for language compatibility and `toolchain go1.26.2` to pin the expected patch-level toolchain. |
|
|
||
| #### Building from Source | ||
|
|
||
| Building from source requires the Go 1.26.2 toolchain. The module declares `go 1.26` for language compatibility and `toolchain go1.26.2` for the expected compiler patch version. |
| | golangci-lint | latest | Linting | | ||
| | make | any | Build automation | | ||
|
|
||
| The `go.mod` file keeps the language version at `go 1.26` and pins the expected patch-level compiler with `toolchain go1.26.2`. Keep `.tool-versions`, CI `setup-go` entries, Docker build images, and documentation aligned with that toolchain version. |
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.
Summary
Validation