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

Support for GitHub Workflow Commands #4835

Open
nikeee opened this issue Feb 2, 2024 · 0 comments
Open

Support for GitHub Workflow Commands #4835

nikeee opened this issue Feb 2, 2024 · 0 comments

Comments

@nikeee
Copy link

nikeee commented Feb 2, 2024

GitHub actions supports putting annotations in source files during a CI run:
https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions

This can be used to highlight linter issues directly in the source.

Popular tools like eslint and biome support it and it looks like this:
image

Integration is fairly simple as it just requires printing special commands to stdout. To avoid breaking changes, biome is checking for the env var GITHUB_ACTIONS. If it's present and its value is true, then additional annotations are emitted.

I think it would be nice if phan would support this as well. I've built the support for biome and if its a feature you'd deem worth supporting, I'd volunteer to implement it for phan as well.

Edit:
I've created a plugin that adds support:
https://gist.github.com/nikeee/c2107b3e3d30ec8100b9fa83f1e2f4ac

Is this something that aligns with the project's goal?

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

1 participant