Skip to content

Conversation

@jllovet
Copy link
Contributor

@jllovet jllovet commented Aug 9, 2025

What type of PR is this?

  • Documentation

What this PR does / why we need it:

Contributor docs did not include that gfmrun is a dependency for running make all. The PR adds a few lines with instructions on doing that.

Special notes for your reviewer:

This is my first PR for this repo. Any suggestions - or a correction if I'm off base here - would be helpful.

Testing

On a machine that does not havegfmrun, run:

git clone https://github.com/urfave/cli.git

Run

make

Final steps should fail.

Now run installation described in PR:

go install github.com/urfave/gfmrun/cmd/gfmrun@latest

Re-run

make

Final steps should pass.

Release Notes

NONE

@jllovet jllovet requested a review from a team as a code owner August 9, 2025 01:35
@dearchap dearchap merged commit ba5d54b into urfave:main Aug 9, 2025
7 checks passed
@meatballhat
Copy link
Member

I think I'd like to address this documentation bug a bit differently since the ensure-gfmrun command is meant to solve the problem and is what's used in CI:

cli/scripts/build.go

Lines 98 to 101 in 3976dfc

{
Name: "ensure-gfmrun",
Action: EnsureGfmrunActionFunc,
},

- run: make ensure-gfmrun

@jllovet
Copy link
Contributor Author

jllovet commented Aug 12, 2025

@meatballhat's suggestion seems reasonable to me, based on my understanding of build.go. gfmrun will get installed by EnsureGfmrunActionFunc if it's missing. Should we refashion this portion of the docs to suggest that a user run make ensure-gfmrun directly? While we're at it, are there other things that would be good to check or run for someone trying to contribute?

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.

4 participants