Skip to content

fix(docs): fix formatting inconsistency, outdated Go version, and grammar #663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
archy-rock3t-cloud wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(docs): fix formatting inconsistency, outdated Go version, and grammar #663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Download the pre-compiled binaries from the [releases page](https://github.com/o

## Building from Source

Make sure you have Go 1.20 or later installed. See the [Go downloads](https://go.dev/dl/) page.
Make sure you have Go 1.25 or later installed. See the [Go downloads](https://go.dev/dl/) page.
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Mar 30, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify Go version consistency across docs, module, CI, and Dockerfiles.

set -euo pipefail

echo "README requirement:"
rg -n "Go [0-9]+\.[0-9]+|Go [0-9]+\.[0-9]+ or later" README.md -C 1

echo
echo "go.mod toolchain:"
rg -n "^go [0-9]+\.[0-9]+(\.[0-9]+)?$" go.mod -C 1

echo
echo "CI go-version source:"
rg -n "go-version-file|go-version" .github/workflows/main.yaml -C 2

echo
echo "Dockerfiles with Go base images:"
fd -a -i "Dockerfile" | xargs -r rg -n "FROM .*go:[0-9]+\.[0-9]+"

Repository: openfga/cli

Length of output: 1579

🏁 Script executed:

# Check if .dev.Dockerfile exists and examine its contents
fd -a -i "dockerfile" -o "dockerfile.*" 

# Also check the first line of any Dockerfile or .dev.Dockerfile
fd -type f -name "*[Dd]ocker*" | head -20

# If .dev.Dockerfile exists, show its contents
if [ -f ".dev.Dockerfile" ]; then
  echo "=== .dev.Dockerfile contents ===" && cat -n .dev.Dockerfile | head -20
fi

# Check all Dockerfile variants
for f in .dev.Dockerfile Dockerfile docker-compose.yml; do
  if [ -f "$f" ]; then
    echo "=== $f ===" && cat -n "$f" | head -10
  fi
done

Repository: openfga/cli

Length of output: 1270

Update .dev.Dockerfile to use Go 1.25 for consistency with documented and toolchain versions.

README.md requires Go 1.25+, go.mod specifies go 1.25.0, and CI workflows use go-version-file: './go.mod'. However, .dev.Dockerfile Line 1 still uses cgr.dev/chainguard/go:1.20. Update the dev container to Go 1.25 to prevent local dev/build drift.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 111, The dev container base image still uses
cgr.dev/chainguard/go:1.20; update the FROM line in .dev.Dockerfile to the Go
1.25 image (e.g., cgr.dev/chainguard/go:1.25 or cgr.dev/chainguard/go:1.25.0) so
it matches README.md, go.mod (go 1.25.0) and CI which reads go-version-file;
ensure any pinned tags or references in that file are updated accordingly.


1. Clone the repo to a local directory, and navigate to that directory:

Expand Down
2 changes: 1 addition & 1 deletion internal/cmdutils/cmdutils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ See the License for the specific language governing permissions and
limitations under the License.
*/

// Package cmdutils contains utility and common functions that interaction with the input
// Package cmdutils contains utility and common functions that interact with the input
// such as reading or binding flags
package cmdutils
2 changes: 1 addition & 1 deletion internal/storetest/testresult.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ func buildTestResultOutput(result TestResult, totalCheckCount int, failedCheckCo
}

if totalListUsersCount > 0 {
output += fmt.Sprintf("ListUsers(%d/%d passing)",
output += fmt.Sprintf("ListUsers (%d/%d passing)",
totalListUsersCount-failedListUsersCount, totalListUsersCount)
}

Expand Down
Loading