Skip to content
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.

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

Make v3 examples runnable on pkg.go.dev #1812

Merged
merged 1 commit into from
Sep 13, 2023

Conversation

matthewdale
Copy link
Contributor

What type of PR is this?

  • documentation

What this PR does / why we need it:

Makes the examples rendered on pkg.go.dev runnable for v3.

Which issue(s) this PR fixes:

Fixes #1811.

Testing

  1. Install pkgsite.
go install golang.org/x/pkgsite/cmd/pkgsite@latest
  1. Browse to the cli repository root.
  2. Run pkgsite
pkgsite
  1. Browse to http://localhost:8080/github.com/urfave/cli/v3#example-Command.Run-NoAction

The existing examples have no main function and are not runnable:
Screenshot 2023-09-02 at 2 57 17 PM

The fixed examples have a main and a "Run" button:
Screenshot 2023-09-02 at 2 56 48 PM

Release Notes

Make v3 examples runnable on pkg.go.dev.

@matthewdale matthewdale requested a review from a team as a code owner September 2, 2023 22:04
@matthewdale matthewdale temporarily deployed to frogbot September 2, 2023 22:04 — with GitHub Actions Inactive
@github-actions
Copy link

Frogbot also supports Contextual Analysis, Secret Detection and IaC Vulnerabilities Scanning. This features are included as part of the JFrog Advanced Security package, which isn't enabled on your system.


@dearchap dearchap merged commit a8de551 into urfave:main Sep 13, 2023
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make v3 examples runnable on pkg.go.dev
3 participants