fix(docs): update installation instructions to extract binary from tarball - #496
Merged
Merged
Conversation
gardener-prow
Bot
added
do-not-merge/needs-kind
klocke-io
approved these changes
Sep 11, 2026
klocke-io
left a comment
klocke-io
left a comment
Member
There was a problem hiding this comment.
🚀
Nice, if you want to, you could also add a simple script that checks the operating system and architecture, downloads the correct and latest release and unzips it. Since most people probably would be using docforge in some for of CI pipline.
gardener-documentation, has something you could use as inspiration :)
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: klocke-io The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
LGTM label has been added. DetailsGit tree hash: 3815e1154a3e44adcb90f6a96ba8528626d60afa |
gardener-prow
Bot
added
the
approved
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
2 participants
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.
What this PR does / why we need it:
Release artifacts published to GitHub are gzip tarballs, not plain executables. The previous installation instructions only ran chmod +x on the downloaded file, which caused an exec format error when users tried to run it. This PR updates the README to include the tar -xzf extraction step.
Which issue(s) this PR fixes:
Fixes #495
Special notes for your reviewer:
Release note: