Skip to content

doc: set GOTOOLCHAIN=auto for RTD Go builds#1208

Merged
roosterfish merged 1 commit intocanonical:mainfrom
minaelee:fix-rtd-build-issue
Feb 3, 2026
Merged

doc: set GOTOOLCHAIN=auto for RTD Go builds#1208
roosterfish merged 1 commit intocanonical:mainfrom
minaelee:fix-rtd-build-issue

Conversation

@minaelee
Copy link
Contributor

@minaelee minaelee commented Feb 2, 2026

Update .readthedocs.yaml to set GOTOOLCHAIN=auto when building the lxd integration and make doc-html-rtd. This fixes RTD build issues by allowing Go to auto-fetch the required Go patch version when the local toolchain is outdated.

@github-actions github-actions bot added the Documentation Documentation needs updating label Feb 2, 2026
@minaelee minaelee force-pushed the fix-rtd-build-issue branch from ec7f90d to 4844ce4 Compare February 2, 2026 17:46
Update .readthedocs.yaml to set GOTOOLCHAIN=auto when building
the lxd integration and make doc-html-rtd. This fixes RTD build
issues by allowing Go to auto-fetch the required Go patch version
when the local toolchain is outdated.

Signed-off-by: Minae Lee <minae.lee@canonical.com>
@minaelee minaelee changed the title doc: update RTD config for go version doc: set GOTOOLCHAIN=auto for RTD Go builds Feb 2, 2026
@minaelee minaelee force-pushed the fix-rtd-build-issue branch from 4844ce4 to 7d87d30 Compare February 2, 2026 18:12
@minaelee minaelee marked this pull request as ready for review February 2, 2026 18:13
@minaelee
Copy link
Contributor Author

minaelee commented Feb 2, 2026

Linkcheck is failing due to issues that are fixed in #1206. This PR otherwise behaves as expected - the correct version of Go is fetched during the RTD build and the RTD build succeeds.

@minaelee minaelee requested a review from roosterfish February 2, 2026 22:02
- git fetch --unshallow || true
- cd doc && make integrate
- cd doc/integration/lxd/ && go build -ldflags "-s -w" -o trimpath -o lxc.bin ./lxc
- cd doc && make GOTOOLCHAIN=auto integrate
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This means we still have to update the golang: "1.25" line above once we go to 1.26 if I understand correctly. But it ensures the right patch version is picked. LGTM.

@roosterfish roosterfish merged commit 278b34b into canonical:main Feb 3, 2026
12 of 13 checks passed
roosterfish added a commit that referenced this pull request Feb 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Documentation needs updating

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants