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

missing type link when run in CI #114

Closed
jan-xyz opened this issue Jul 8, 2024 · 4 comments
Closed

missing type link when run in CI #114

jan-xyz opened this issue Jul 8, 2024 · 4 comments

Comments

@jan-xyz
Copy link

jan-xyz commented Jul 8, 2024

When I locally generate the markdown it seems to differ from the output that is generated when GitHub actions runs the CLI

internal/plugins/appstore/README.md - (expected) (actual)
19 | 19 |   
20 | 20 |   <a name="App"></a>
21 | 21 |   ## type [App](<
https://github.com/jan-xyz/dotfiles/blob/main/internal/plugins/appstore/plugin.go#L14-L17
>)
Error: output does not match current files. Did you forget to run gomarkdoc?

(The expected here is ## type App)

I run it with
github.com/princjef/gomarkdoc/cmd/gomarkdoc --check --output "{{.Dir}}/README.md" --format github ./internal/... to check it and with go run github.com/princjef/gomarkdoc/cmd/gomarkdoc --output "{{.Dir}}/README.md" --format github ./internal/... to generate the markdown.

@sunglim
Copy link

sunglim commented Jul 14, 2024

The same in my workflow. It failed in only in workflow. When I run gomarkdoc ./... on my local, it is fine.

 <a name="Abs"></a>
-## func [Abs](<https://github.com/cinar/indicator/blob/master/helper/abs.go#L15>)
+## func Abs

@sunglim
Copy link

sunglim commented Jul 14, 2024

This issue is a duplicate of #84

@jan-xyz
Copy link
Author

jan-xyz commented Jul 14, 2024

Thanks, this solved it! jan-xyz/Dotfiles#115

@jan-xyz jan-xyz closed this as completed Jul 14, 2024
@sunglim
Copy link

sunglim commented Jul 16, 2024

Thanks, this solved it! jan-xyz/Dotfiles#115

I'm happy to help. I could get a hint by using -vv option. it prints INFO log ;)

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

No branches or pull requests

2 participants