Improve error message when func describe is run outside function directory

[RayyanSeliya]

Changes

• 🧹 Update error message shown when func describe is run outside a function directory.
• Made the message more user-friendly and easier for beginners to understand.
• Replaced cryptic technical error with clear, actionable guidance.
• Provides context-specific information about function description workflow.

/kind enhancement

Fixes #3026

Release Note

Improve error message when `func describe` is run outside function directory
to be more beginner-friendly and provide clear guidance on creating functions
before describing them.

[knative-prow]

Hi @RayyanSeliya. Thanks for your PR.

I'm waiting for a knative member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[codecov]

Codecov Report

❌ Patch coverage is 95.83333% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 59.21%. Comparing base (bfd65ae) to head (3901142).

Files with missing lines	Patch %	Lines
cmd/describe.go	95.83%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3027      +/-   ##
==========================================
+ Coverage   55.66%   59.21%   +3.54%     
==========================================
  Files         134      134              
  Lines       17315    17338      +23     
==========================================
+ Hits         9638    10266     +628     
+ Misses       6773     6108     -665     
- Partials      904      964      +60     

Flag	Coverage Δ
e2e-tests	40.23% <0.00%> (+10.48%)	⬆️
integration-tests	54.01% <95.83%> (+1.77%)	⬆️
unit-tests	46.33% <95.83%> (+0.06%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[lkingland]

/lgtm
Thanks for the improved error message.

[lkingland]

This one is failing on TestDescribe_Default in cmd/describe_test.go which checks:

// TestDescribe_Default ensures that running describe when there is no
// function in the given directory fails correctly.
func TestDescribe_Default(t *testing.T) {
	_ = FromTempDirectory(t)
	describer := mock.NewDescriber()

	cmd := NewDescribeCmd(NewTestClient(fn.WithDescriber(describer)))
	cmd.SetArgs([]string{})
	err := cmd.Execute()

	if err == nil {
		t.Fatal("describing a nonexistent function should error")
	}
	if !strings.Contains(err.Error(), "function not found at this path and no name provided") {
		t.Fatalf("Unexpected error text returned: %v", err)
	}
	if describer.DescribeInvoked {
		t.Fatal("Describer incorrectly invoked")
	}
}

[lkingland]

You'll need to update the test which spot-checks this output I believe.

[RayyanSeliya]

hey @lkingland dont know why the test are failing i think its an infrastructure /network issue i have updated the test to check our new description !

[lkingland]

/lgtm

[knative-prow]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lkingland, RayyanSeliya

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [lkingland]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[lkingland]

/retest

[knative-prow]

New changes are detected. LGTM label has been removed.