Add GitHub Actions annotations #34
Conversation
|
This is currently very light on tests. I also wonder about the additional class. See voxpupuli/puppet-example#19 for an example: |
| def override_env | ||
| old_env = ENV.clone | ||
| yield | ||
| ensure | ||
| ENV.clear | ||
| ENV.update(old_env) | ||
| end |
There was a problem hiding this comment.
I wasn't quite sure about this, but I wrote it on the train without internet access.
There was a problem hiding this comment.
Well, it works. I just don't know if this is the desired solution in this repo.
ekohl
force-pushed
the
add-github-actions-annotations
branch
from
e1e7e81 to
d91347e
Compare
|
It looks like no CI ran, only the CLA check. I'm not sure why that is. |
That’s weird… |
|
Found it and it's the same thing we suffer from in theforeman: https://github.com/puppetlabs/puppet-lint/actions/workflows/ci.yml shows
This is because there's a schedule and regular PR testing in the same workflow, which is very annoying. |
|
See, it was good that we enabled CI. Looks like I need to please Rubocop. |
This should be no difference in execution, but it pleases Rubocop in the next commit when some code is added and makes review easier.
ekohl
force-pushed
the
add-github-actions-annotations
branch
from
d91347e to
670cbac
Compare
|
It looks like there's an interesting interaction I didn't foresee: the CI runs on GitHub actions as well so that's generating the warnings in this test suite, which was not intended. Looks like I need to use the configuration option I implemented. |
It is possible to get inline annotations with GitHub Actions. This is based on Rubocop's formatter. It's implemented as a configuration option that's dynamic by default. This means it will show up in actions, but not in other environments. Overriding is still possible.
ekohl
force-pushed
the
add-github-actions-annotations
branch
from
670cbac to
b70093d
Compare
| override_env do | ||
| ENV.delete('GITHUB_ACTION') | ||
| subject.defaults | ||
| end |
There was a problem hiding this comment.
Annotating my own code: technically this is redundant now that there's ENV.delete() in spec_helper.rb, but it doesn't hurt to be explicit.
| # Disable GitHub Actions reporting since it breaks the test suite | ||
| ENV.delete('GITHUB_ACTION') |
There was a problem hiding this comment.
This isn't the cleanest, but I couldn't find a good way to consistently set the setting. Right now I don't think it would break anything.
|
@ekohl Apologies, I forgot to get back to you. This does indeed break PDK rendering rather spectacularly when running with a |
|
Fascinating. I wonder what it's doing. Is it by any chance using JSON output? |
|
I believe #35 should fix it, or at least unbreak JSON mode. Could you verify that? |
|
👍 looks good |
It is possible to get inline annotations with GitHub Actions. This is based on Rubocop's formatter.
It's implemented as a configuration option that's dynamic by default. This means it will show up in actions, but not in other environments. Overriding is still possible.