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

Feature request: link to the issue reference in the comment #79

Closed
atkinsonm opened this issue Apr 4, 2023 · 2 comments
Closed

Feature request: link to the issue reference in the comment #79

atkinsonm opened this issue Apr 4, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@atkinsonm
Copy link

As a user of the markdownlint-cli2-action, I would like the inline comments of the actions to hyperlink to the relevant documentation e.g. https://github.com/DavidAnson/markdownlint/blob/main/doc/md034.md so I can quickly reference the rational for an issue and how to fix it.

@DavidAnson
Copy link
Owner

It's a reasonable request, but I don't think it's quite possible today the way you have in mind. Those are called annotations, and they are published via this API: https://github.com/actions/toolkit/tree/main/packages/core#annotations. As you can see if you scroll down a bit, there is no option to pass a link for more information.

Best effort, I could append the URL to the end of the text field, where I suppose you could copy and paste it. Or maybe we will get lucky and they will auto detect that link and make it clickable in the report.

I will have a look at this during the next round of updates.

@DavidAnson DavidAnson added the enhancement New feature or request label Apr 4, 2023
DavidAnson added a commit that referenced this issue Apr 8, 2023
… in GitHub), add

endLine/endColumn data to annotations, use output formatter instead of parsing logError
(fixes #79).
@atkinsonm
Copy link
Author

I tried this out today and it is working, at least the basic version. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants