Use project Go version for generating website content #542
Conversation
This file contains 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
per1234
added
topic: infrastructure
The project documentation is published on a companion website. A GitHub Actions workflow is used to automatically update
the website whenever any relevant file is changed in the repository. This website includes content generated from the
project's Go code.
Previously, the default version of Go from the GitHub Actions runner machine was used for generating the documentation
content. A recent update of this default Go version from 1.17 to 1.20 caused the generation process to fail:
```
task: [go:rule-docs] ./ruledocsgen ../docs/rules
panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0x18 pc=0xa29866]
goroutine 1 [running]:
debug/elf.(*Section).ReadAt(0xc0003a4000?, {0xc000376000?, 0x24?, 0x23?}, 0x23?)
<autogenerated>:1 +0x26
archive/zip.readDirectoryEnd({0xe9d780, 0xc000328b80}, 0x210)
/opt/hostedtoolcache/go/1.20.4/x64/src/archive/zip/reader.go:581 +0xf5
archive/zip.(*Reader).init(0xc00030bc70, {0xe9d780?, 0xc000328b80}, 0x210)
/opt/hostedtoolcache/go/1.20.4/x64/src/archive/zip/reader.go:124 +0x5c
archive/zip.NewReader({0xe9d780, 0xc000328b80}, 0x210)
/opt/hostedtoolcache/go/1.20.4/x64/src/archive/zip/reader.go:103 +0x5e
github.com/daaku/go%2ezipexe.zipExeReaderElf({0xea05a0?, 0xc000120840}, 0x1846986)
/home/runner/go/pkg/mod/github.com/daaku/go.zipexe@v1.0.1/zipexe.go:128 +0x8b
github.com/daaku/go%2ezipexe.NewReader({0xea05a0, 0xc000120840}, 0x0?)
/home/runner/go/pkg/mod/github.com/daaku/go.zipexe@v1.0.1/zipexe.go:48 +0x98
github.com/daaku/go%2ezipexe.OpenCloser({0xc0001543c0?, 0xc000147390?})
/home/runner/go/pkg/mod/github.com/daaku/go.zipexe@v1.0.1/zipexe.go:30 +0x57
github.com/cmaglie/go%2erice.init.0()
/home/runner/go/pkg/mod/github.com/cmaglie/go.rice@v1.0.3/appended.go:42 +0x65
```
This error, and the general fragility that comes from the lack of control over the Go version, is avoided by configuring
the workflow to use the specific version of Go that is used for development and validation of the project.
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.
The project documentation is published on a companion website. A GitHub Actions workflow is used to automatically update the website whenever any relevant file is changed in the repository. This website includes content generated from the project's Go code.
Previously, the default version of Go from the GitHub Actions runner machine was used for generating the documentation content. A recent update of this default Go version from 1.17 to 1.20 (actions/runner-images#7276) caused the generation process to fail:
This error, and the general fragility that comes from the lack of control over the Go version, is avoided by configuring the workflow to use the specific version of Go that is used for development and validation of the project.
Demonstration in my fork of a successful run of the updated "Deploy Website" workflow:
https://github.com/per1234/arduino-lint/actions/runs/4955499040/jobs/8864951607#step:7:23
Demonstration run of the updated "Check Markdown" workflow:
https://github.com/arduino/arduino-lint/actions/runs/4955538345/jobs/8865023358?pr=542#step:5:238
This run still fails, but the cause of the failure is now legitimate (broken links) rather than a spurious failure caused by the generation process erroring.