Skip to content

Fix package README error lint failure #52196

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

Merged
pelikhan merged 2 commits into from
Aug 12, 2026
Merged

Fix package README error lint failure #52196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e7d2c7
Initial plan
Copilot Aug 12, 2026
3dcdf26
Fix package README lint error
Copilot Aug 12, 2026
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 pkg/cli/add_package_manifest.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -719,7 +719,7 @@ func resolveRepositoryPackageDocsPath(ctx context.Context, owner, repo, packageP
if _, err := downloadPackageFileFromGitHubForHost(ctx, owner, repo, readmePath, ref, host); err == nil {
return readmePath, nil
} else if isRepositoryFileNotFound(err) {
return "", fmt.Errorf("repository %q is not a valid Agentic Workflow package: missing required README.md at %q. Add a README.md describing the package. Example:\n# My Package\n\nDescribe what this package does.", packageID, readmePath)
return "", fmt.Errorf("repository %q is not a valid Agentic Workflow package: missing required README.md at %q. Add a README.md describing the package. Example:\n# My Package\n\nDescribe what this package does", packageID, readmePath)
} else {
return "", fmt.Errorf("failed to read package README %q from %s/%s@%s (check the repository, ref, and network connectivity): %w", readmePath, owner, repo, ref, err)
}
Expand Down
3 changes: 1 addition & 2 deletions pkg/cli/add_package_manifest_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -637,8 +637,7 @@ files:
}

_, err := resolveRepositoryPackage(t.Context(), &RepoSpec{RepoSlug: "owner/repo"}, "")
require.Error(t, err)
require.ErrorContains(t, err, `missing required README.md`)
require.EqualError(t, err, "repository \"owner/repo\" is not a valid Agentic Workflow package: missing required README.md at \"README.md\". Add a README.md describing the package. Example:\n# My Package\n\nDescribe what this package does")
})

t.Run("reports nested package path when README is missing", func(t *testing.T) {
Expand Down
Loading