Use reviewdog to annotate PR's with black and flake8 errors. #1424

jcapriot · 2024-04-15T21:01:17Z

Summary

Uses reviewdog to annotate PR's with suggested changes from black, and comment on errors from flake8

PR Checklist

If this is a work in progress PR, set as a Draft PR
Linted my code according to the style guides.
Added tests to verify changes to the code.
Added necessary documentation to any new functions/classes following the
expect style.
Marked as ready for review (if this is was a draft PR), and converted
to a Pull Request
Tagged @simpeg/simpeg-developers when ready for review.

What does this implement/fix?

Allows for automated reviewing of PR's from reviewdog detailing the flake8 and black errors when they fail, making it much more obvious to people who have submitted PR's about why those tests are failing.

(and perform a verified commit)

SimPEG/data_misfit.py

SimPEG/data.py

jcapriot · 2024-04-15T21:13:29Z

@santisoler Check this out!

jcapriot · 2024-04-15T21:15:28Z

Obviously I've currently added purposeful places for the checks to fail to look at the output, I'll make sure it triggers azure tests as well after the "failures" are fixed.

santisoler · 2024-04-15T21:33:39Z

Looks great! I think it could greatly improve the experience for new contributors.

Is there a way to get the github bot to use the reviewdog logo?? Would love to have it barking at us for forgetting to run black haha

jcapriot · 2024-04-15T22:29:57Z

Looks great! I think it could greatly improve the experience for new contributors.

Is there a way to get the github bot to use the reviewdog logo?? Would love to have it barking at us for forgetting to run black haha

I don't see an option to get that setup through the pre-made actions for flake8 and black unfortunately.

jcapriot · 2024-04-15T22:44:50Z

Perfect, looks to have properly triggered the azure pipelines runs after the style checks.

codecov · 2024-04-15T22:51:01Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.54%. Comparing base (fa5d794) to head (63f02fe).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1424      +/-   ##
==========================================
+ Coverage   74.16%   82.54%   +8.38%     
==========================================
  Files         167      167              
  Lines       25700    25700              
==========================================
+ Hits        19060    21214    +2154     
+ Misses       6640     4486    -2154

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

jcapriot · 2024-04-16T14:19:03Z

Now just need to make sure it triggers a run on this branch…

SimPEG/data.py

jcapriot · 2024-04-16T20:13:22Z

Ok, I'm happy with how this is setup now.
It does re-run the black/flake8 tests on azure, mostly because we still only want the tests to run if those things pass. Essentially the GitHub-actions workflow is only used to post review comments detailing for users about the specific flake8 error, or how to change the formatting to satisfy black.

…e_simpeg_021 * commit 'fe444e2d714ab1a3f1541575a9f8c4ad1e74894b': (73 commits) Fix distance calculation in `convert_survey_3d_to_2d_lines` (simpeg#1390) Rename spontaneous potential to self potential (simpeg#1422) Lowercase simpeg for generating coverage on Azure (simpeg#1443) Replace SimPEG for simpeg across docstrings (simpeg#1438) Update copyright year in __init__.py (simpeg#1436) Move to a PEP8 compliant package name. (simpeg#1430) Fix rst syntax in release notes for v0.21.0 (simpeg#1434) Replace use of `refine_tree_xyz` in DCIP tutorials (simpeg#1381) Add new Issue template for making a release (simpeg#1410) Safely run reviewdog on `pull_request_target` events (simpeg#1427) Use reviewdog to annotate PR's with black and flake8 errors. (simpeg#1424) Remove the parameters argument from docstring (simpeg#1417) Add release notes for v0.21.1 (simpeg#1416) Fix hard dask dependency (simpeg#1415) Publish documentation on azure (simpeg#1412) Add release notes for SimPEG v0.21 (simpeg#1409) Bump Black version to 24.3.0 (simpeg#1403) Remove link to "twitter" (simpeg#1406) Add Ying and Williams to AUTHORS.rst (simpeg#1405) Dask MetaSim (simpeg#1199) ... # Conflicts: # simpeg/electromagnetics/base_1d_stitched.py # simpeg/electromagnetics/frequency_domain/simulation_1d_stitched.py # simpeg/electromagnetics/time_domain/receivers.py # simpeg/electromagnetics/time_domain/simulation_1d_stitched.py # simpeg/electromagnetics/utils/em1d_utils.py # simpeg/potential_fields/magnetics/_numba_functions.py # simpeg/regularization/laterally_constrained.py # simpeg/regularization/regularization_mesh_lateral.py # simpeg/regularization/rotated.py # simpeg/utils/__init__.py # simpeg/utils/model_utils.py # tests/base/regularizations/test_full_gradient.py # tests/base/regularizations/test_regularization.py # tests/base/test_mass_matrices.py # tests/base/test_model_utils.py # tests/base/test_utils.py # tests/em/fdem/inverse/adjoint/test_FDEM_adjointEB.py # tests/em/fdem/inverse/derivs/test_FDEM_derivs.py # tests/pf/test_forward_Mag_Linear.py

…al_update_21_release * commit '07aeb65de865cd9df55e2d51ca840ea9d60f2234': (67 commits) Fix rst syntax in release notes for v0.21.0 (simpeg#1434) Replace use of `refine_tree_xyz` in DCIP tutorials (simpeg#1381) Add new Issue template for making a release (simpeg#1410) Safely run reviewdog on `pull_request_target` events (simpeg#1427) Use reviewdog to annotate PR's with black and flake8 errors. (simpeg#1424) Remove the parameters argument from docstring (simpeg#1417) Add release notes for v0.21.1 (simpeg#1416) Fix hard dask dependency (simpeg#1415) Publish documentation on azure (simpeg#1412) Add release notes for SimPEG v0.21 (simpeg#1409) Bump Black version to 24.3.0 (simpeg#1403) Remove link to "twitter" (simpeg#1406) Add Ying and Williams to AUTHORS.rst (simpeg#1405) Dask MetaSim (simpeg#1199) Update year in LICENSE (simpeg#1404) Update AUTHORS.rst (simpeg#1259) Minor adjustments to Sphinx configuration (simpeg#1398) Enforce regularization `weights` as dictionaries (simpeg#1344) Improve documentation for base simulation classes (simpeg#1295) Add link to User Tutorials to navbar in docs (simpeg#1401) ... # Conflicts: # SimPEG/electromagnetics/time_domain/receivers.py # SimPEG/utils/__init__.py # SimPEG/utils/model_utils.py # tests/base/regularizations/test_full_gradient.py # tests/base/regularizations/test_regularization.py # tests/base/test_model_utils.py # tests/base/test_utils.py # tests/pf/test_forward_Mag_Linear.py

…ting_strategy * commit 'fe444e2d714ab1a3f1541575a9f8c4ad1e74894b': (86 commits) Fix distance calculation in `convert_survey_3d_to_2d_lines` (simpeg#1390) Rename spontaneous potential to self potential (simpeg#1422) Lowercase simpeg for generating coverage on Azure (simpeg#1443) Replace SimPEG for simpeg across docstrings (simpeg#1438) Update copyright year in __init__.py (simpeg#1436) Move to a PEP8 compliant package name. (simpeg#1430) Fix rst syntax in release notes for v0.21.0 (simpeg#1434) Replace use of `refine_tree_xyz` in DCIP tutorials (simpeg#1381) Add new Issue template for making a release (simpeg#1410) Safely run reviewdog on `pull_request_target` events (simpeg#1427) Use reviewdog to annotate PR's with black and flake8 errors. (simpeg#1424) Remove the parameters argument from docstring (simpeg#1417) Add release notes for v0.21.1 (simpeg#1416) Fix hard dask dependency (simpeg#1415) Publish documentation on azure (simpeg#1412) Add release notes for SimPEG v0.21 (simpeg#1409) Bump Black version to 24.3.0 (simpeg#1403) Remove link to "twitter" (simpeg#1406) Add Ying and Williams to AUTHORS.rst (simpeg#1405) Dask MetaSim (simpeg#1199) ... # Conflicts: # simpeg/utils/__init__.py # simpeg/utils/model_utils.py # tests/base/test_model_utils.py

jcapriot added 9 commits April 15, 2024 13:56

Use github actions to trigger pull request reviews and tests

0193cd9

add a flake8 error

51f1c96

add a black error

cf87c8e

Disable pr trigger on azure-pipelines

28a048a

trying to get workflow to run...

698eec7

add runs-on to testing job

d1a5e19

(and perform a verified commit)

Update pull_request.yml

bb42865

Create pull_request.yml

e0d96af

Merge branch 'reviewdog' into reviewdog-1

6616779

jcapriot changed the title ~~Create pull_request.yml~~ Use reviewdog to annotate PR's with black and flake8 errors. Apr 15, 2024

make checks fail on flake8 and black errors

ce3f12f

github-actions bot reviewed Apr 15, 2024

View reviewed changes

SimPEG/data_misfit.py Outdated Show resolved Hide resolved

github-actions bot reviewed Apr 15, 2024

View reviewed changes

SimPEG/data.py Outdated Show resolved Hide resolved

jcapriot requested review from santisoler and lheagy April 15, 2024 21:13

try setting reviewdog_token

ced76ab

jcapriot added 3 commits April 15, 2024 16:32

revert last

d5faf47

fix intentional style errors

6439f7b

change indent

cf5d88a

jcapriot added 3 commits April 16, 2024 10:25

Reset azure-pipelines.yml to try to go through that.

aac5f44

test errors

128da6e

Try running reviewdog through azure

317a39d

github-actions bot reviewed Apr 16, 2024

View reviewed changes

SimPEG/data.py Outdated Show resolved Hide resolved

github-actions bot reviewed Apr 16, 2024

View reviewed changes

SimPEG/data.py Outdated Show resolved Hide resolved

jcapriot added 16 commits April 16, 2024 13:09

update pipeline syntax

ebaca50

move env variables

4d49081

set as variables for the style stage

deb147e

fix syntax

bbacce1

change script name

33f225d

add executable permissions.

b319096

more syntax

43632b6

try github-pr-check

c6bbf26

add back -f

2a8bb0c

print black output before pushing to reviewdog

367a5b0

fix call

7cc1df6

Explicitly map secret as environment variable

d13fbe8

change to PR number

e7af82b

reset azure-pipelines

05ebc4e

no need to report error, just use this workflow to annotate PR's

4b7638a

fix errors

63f02fe

jcapriot merged commit 999d18c into main Apr 16, 2024
18 checks passed

jcapriot deleted the reviewdog-1 branch April 16, 2024 22:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use reviewdog to annotate PR's with black and flake8 errors. #1424

Use reviewdog to annotate PR's with black and flake8 errors. #1424

jcapriot commented Apr 15, 2024 •

edited

jcapriot commented Apr 15, 2024

jcapriot commented Apr 15, 2024

santisoler commented Apr 15, 2024

jcapriot commented Apr 15, 2024

jcapriot commented Apr 15, 2024

codecov bot commented Apr 15, 2024 •

edited

jcapriot commented Apr 16, 2024

jcapriot commented Apr 16, 2024

Use reviewdog to annotate PR's with black and flake8 errors. #1424

Use reviewdog to annotate PR's with black and flake8 errors. #1424

Conversation

jcapriot commented Apr 15, 2024 • edited

Summary

PR Checklist

What does this implement/fix?

jcapriot commented Apr 15, 2024

jcapriot commented Apr 15, 2024

santisoler commented Apr 15, 2024

jcapriot commented Apr 15, 2024

jcapriot commented Apr 15, 2024

codecov bot commented Apr 15, 2024 • edited

Codecov Report

jcapriot commented Apr 16, 2024

jcapriot commented Apr 16, 2024

jcapriot commented Apr 15, 2024 •

edited

codecov bot commented Apr 15, 2024 •

edited