Skip to content

chore(ci): improve wemake workflow logging#15105

Merged
mpfirrmann merged 1 commit intomagma:masterfrom
mpfirrmann:pr/weemake_logging
Mar 6, 2023
Merged

chore(ci): improve wemake workflow logging#15105
mpfirrmann merged 1 commit intomagma:masterfrom
mpfirrmann:pr/weemake_logging

Conversation

@mpfirrmann
Copy link
Copy Markdown
Contributor

Summary

Improve the weemake workflow to echo a hint for local linting.
This code change was separated from #14831 to simplify code review.

Test Plan

Additional Information

  • This change is backwards-breaking

@mpfirrmann mpfirrmann requested a review from LKreutzer March 1, 2023 08:26
@mpfirrmann mpfirrmann self-assigned this Mar 1, 2023
@mpfirrmann mpfirrmann requested a review from a team as a code owner March 1, 2023 08:26
@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines. label Mar 1, 2023
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 1, 2023

Thanks for opening a PR! 💯

A couple initial guidelines

Howto

  • Reviews. The "Reviewers" listed for this PR are the Magma maintainers who will shepherd it.
  • Checks. All required CI checks must pass before merge.
  • Merge. Once approved and passing CI checks, use the ready2merge label to indicate the maintainers can merge your PR.

More info

Please take a moment to read through the Magma project's

If this is your first Magma PR, also consider reading

@github-actions github-actions bot added the component: ci All updates on CI (Jenkins/CircleCi/Github Action) label Mar 1, 2023
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 1, 2023

DP Lint & Test

0 tests   0 ✔️  0s ⏱️
0 suites  0 💤
0 files    0

Results for commit f18d7bf.

- name: Info for local execution
if: failure()
run: |
echo "Running linting tools failed. This should be equivalent to running './lte/gateway/python/precommit.py --lint --diff' locally."
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this actually equivalent given that the wemake-python-styleguide action outputs comments for entire edited files? Is this what ./lte/gateway/python/precommit.py --lint --diff does?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understanding is that the wemake styleguide was added to the docker container running with the precommit.py with #14994 and that the edited files are checked entirely. Or am I mistaken @LKreutzer?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Locally only the last commit is checked and in CI everything up to the merge-base, but otherwise they should be identical.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just tested this locally with two commits in which I introduced linting errors, and the errors for both commits were reported, so it looks good to me.

@MoritzThomasHuebner MoritzThomasHuebner changed the title chore(ci): improve weemake workflow logging chore(ci): improve wemake workflow logging Mar 2, 2023
@mpfirrmann mpfirrmann requested a review from voisey March 3, 2023 14:33
Copy link
Copy Markdown
Contributor

@wolfseb wolfseb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@mpfirrmann mpfirrmann merged commit ba5f0df into magma:master Mar 6, 2023
@mpfirrmann mpfirrmann deleted the pr/weemake_logging branch March 6, 2023 13:08
lucasgonze pushed a commit to lucasgonze/magma that referenced this pull request Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component: ci All updates on CI (Jenkins/CircleCi/Github Action) size/XS Denotes a PR that changes 0-9 lines.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants