Skip to content

Fixed binary name in description output of bash completion generation cli command #740

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

Merged

Conversation

lbdemv
Copy link

@lbdemv lbdemv commented Dec 21, 2023

Description of your changes

Added missing "s" character in binary name of the "bash completion CLI helptext" output.

I have:

  • Read and followed terraform-docs' [contribution process].
  • All tests pass when I run make test.

How has this code been tested

Run make test. Since i'm not go developer i'm not sure why the tests of a "plain" repo clone on the master branch fails, but my branch also fails after the doc changes... ?!

PASS
coverage: 89.5% of statements
ok  	github.com/terraform-docs/terraform-docs/internal/types	0.006s	coverage: 89.5% of statements
FAIL	github.com/terraform-docs/terraform-docs/print [build failed]
FAIL	github.com/terraform-docs/terraform-docs/template [build failed]
FAIL	github.com/terraform-docs/terraform-docs/terraform [build failed]
make: *** [Makefile:77: test] Error 2

@khos2ow
Copy link
Member

khos2ow commented Dec 21, 2023

I just tested your PR and it passed on my laptop. It also passes on the actions too. So I'm wondering if you are using older go version. What's your go version?

@lbdemv
Copy link
Author

lbdemv commented Dec 21, 2023

I just installed the go env for this PR via the Ubuntu22.04 apt packages:

~$ go version
go version go1.18.1 linux/amd64
~$ apt show golang
Package: golang
Version: 2:1.18~0ubuntu2

@khos2ow
Copy link
Member

khos2ow commented Dec 21, 2023

Ah right, you need at least minimum go 1.19

@khos2ow
Copy link
Member

khos2ow commented Dec 21, 2023

Also if you search the whole repo for terraform-doc (without the trailing s) there are few other occurrences that you can fix as part of this PR too.

@lbdemv
Copy link
Author

lbdemv commented Dec 21, 2023

Sure i can do that, I didn't think to search because is just stumbled across this instance.

In that case, I upgrade my local go env and try to get the tests running :-)

@lb1a and others added 2 commits March 23, 2024 14:30
Added missing "s" character in description output.

Signed-off-by: @lb1a <github@lb1a.de>
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
@khos2ow khos2ow force-pushed the update-docstring-bash-completion branch from b64e6f5 to d5a55ae Compare March 23, 2024 18:32
@khos2ow khos2ow merged commit 77d395a into terraform-docs:master Mar 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants