adafruit / adabot

Adabot is our robot friend who helps Adafruit online
MIT License
13 stars 27 forks source link

Reduce Errors (Or Validators) On Empty Repos #25

Closed sommersoft closed 5 years ago

sommersoft commented 5 years ago

If an initial library is in work, and nothing is in the repo, almost (if not) all errors will be flagged.

There are a few checks that could still be valuable (Travis enabled, librarians), but the rest could be skipped.

@kattni, add anything to this description I may be missing.

kattni commented 5 years ago

Things that can and should be done to a new/empty repo:

Please leave those checks in place. Everything else should be skipped.


Indirectly related side note, consider changing the error message for CP LIbrarians from:

Likely missing CircuitPythonLibrarians team.

To something like:

CircuitPythonLibrarians team missing or does not have write access.

Because I'm finding a lot of the times that error happens, CPLibrarians has been added but only has Read access to the repo.

sommersoft commented 5 years ago

@kattni here's where its sitting now:

117 out of 118 repos need work.

PyLint version very out of date - 107

For pypi compatibility, missing Adafruit-Blinka in requirements.txt - 16

ReadTheDocs missing the latest release. (Ignore me! RTD doesn't update when a new version is released. Only on pushes.) - 35

Not in bundle. - 4
* https://github.com/adafruit/Adafruit_CircuitPython_CPython
* https://github.com/adafruit/Adafruit_CircuitPython_AT86RF233
* https://github.com/adafruit/Adafruit_CircuitPython_SK9822
* https://github.com/adafruit/Adafruit_CircuitPython_US100

For pypi compatibility, missing pypi provider in .travis.yml - 6
* https://github.com/adafruit/Adafruit_CircuitPython_CPython
* https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad
* https://github.com/adafruit/Adafruit_CircuitPython_FeatherWing
* https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation
* https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground
* https://github.com/adafruit/Adafruit_CircuitPython_MPL115A2

PyLint version not fixed - 7
* https://github.com/adafruit/Adafruit_CircuitPython_CPython
* https://github.com/adafruit/Adafruit_CircuitPython_Register
* https://github.com/adafruit/Adafruit_CircuitPython_seesaw
* https://github.com/adafruit/Adafruit_CircuitPython_AM2320
* https://github.com/adafruit/Adafruit_CircuitPython_BNO055
* https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation
* https://github.com/adafruit/Adafruit_CircuitPython_APDS9960

For pypi compatibility, missing setup.py - 6
* https://github.com/adafruit/Adafruit_CircuitPython_CPython
* https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad
* https://github.com/adafruit/Adafruit_CircuitPython_FeatherWing
* https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation
* https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground
* https://github.com/adafruit/Adafruit_CircuitPython_MPL115A2

ReadTheDocs missing as a subproject on CircuitPython - 1
* https://github.com/adafruit/Adafruit_CircuitPython_CPython

CircuitPython drivers page missing driver - 20

Not listed on PyPi for CPython use - 8
* https://github.com/adafruit/Adafruit_CircuitPython_CPython
* https://github.com/adafruit/Adafruit_CircuitPython_DS18X20
* https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad
* https://github.com/adafruit/Adafruit_CircuitPython_FeatherWing
* https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation
* https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground
* https://github.com/adafruit/Adafruit_CircuitPython_MLX90393
* https://github.com/adafruit/Adafruit_CircuitPython_MPL115A2

Library repository has no releases. - 1
* https://github.com/adafruit/Adafruit_CircuitPython_CPython

Library has new commits since last release. - 66

Missing license. - 3
* https://github.com/adafruit/Adafruit_CircuitPython_AT86RF233
* https://github.com/adafruit/Adafruit_CircuitPython_SK9822
* https://github.com/adafruit/Adafruit_CircuitPython_US100

New repo(s) currently in work, and unreleased. - 3
* https://github.com/adafruit/Adafruit_CircuitPython_AT86RF233
* https://github.com/adafruit/Adafruit_CircuitPython_SK9822
* https://github.com/adafruit/Adafruit_CircuitPython_US100

README image missing alt text - 1
* https://github.com/adafruit/Adafruit_CircuitPython_HCSR04

ReadTheDocs latest build has warnings and/or errors - 2
* https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad
* https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation

Mismatched readthedocs.yml - 3
* https://github.com/adafruit/Adafruit_CircuitPython_DHT
* https://github.com/adafruit/Adafruit_CircuitPython_DS3231
* https://github.com/adafruit/Adafruit_CircuitPython_GPS

Unable to enable Travis build - 1
* https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation

Librarians, [merge, no-rebase, no-squash], Wiki, and License are all in the same validator (single API request). License wasn't in your list, so i can work to get it out for new repos if you'd like.

kattni commented 5 years ago

This is beautiful! You're right that it would be good to also work License out (I missed that one in my initial assessment).

Should we also not have it in the "Not in bundle." list if it's in the "New repo(s)" list?

Are they also removed from the "CP drivers page missing driver" list? Or do I remember you telling me that it was super complicated to do that.

sommersoft commented 5 years ago

edited output above, with higher error depth

You're right that it would be good to also work License out

Can do! Just need to reorder the validators, and catch it. Or move the license check to look for the file instead of the repo license field. We'll see.

Should we also not have it in the "Not in bundle." list if it's in the "New repo(s)" list?

I missed that one!

Are they also removed from the "CP drivers page missing driver" list?

Of course I didn't re-run it with enough error-depth to verify that. Code should catch it. Running it again... :smile:

sommersoft commented 5 years ago

With fixes/verification as noted in previous comment (ran it with -e 25):

117 out of 118 repos need work.

PyLint version very out of date - 107

For pypi compatibility, missing Adafruit-Blinka in requirements.txt - 16
* https://github.com/adafruit/Adafruit_CircuitPython_IRRemote
* https://github.com/adafruit/Adafruit_CircuitPython_CPython
* https://github.com/adafruit/Adafruit_CircuitPython_Register
* https://github.com/adafruit/Adafruit_CircuitPython_DS1307
* https://github.com/adafruit/Adafruit_CircuitPython_PCA9685
* https://github.com/adafruit/Adafruit_CircuitPython_MCP9808
* https://github.com/adafruit/Adafruit_CircuitPython_PCF8523
* https://github.com/adafruit/Adafruit_CircuitPython_Pixie
* https://github.com/adafruit/Adafruit_CircuitPython_TLC59711
* https://github.com/adafruit/Adafruit_CircuitPython_Waveform
* https://github.com/adafruit/Adafruit_CircuitPython_FancyLED
* https://github.com/adafruit/Adafruit_CircuitPython_TLC5947
* https://github.com/adafruit/Adafruit_CircuitPython_miniQR
* https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
* https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation
* https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground

ReadTheDocs missing the latest release. (Ignore me! RTD doesn't update when a new version is released. Only on pushes.) - 35

For pypi compatibility, missing pypi provider in .travis.yml - 6
* https://github.com/adafruit/Adafruit_CircuitPython_CPython
* https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad
* https://github.com/adafruit/Adafruit_CircuitPython_FeatherWing
* https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation
* https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground
* https://github.com/adafruit/Adafruit_CircuitPython_MPL115A2

PyLint version not fixed - 7
* https://github.com/adafruit/Adafruit_CircuitPython_CPython
* https://github.com/adafruit/Adafruit_CircuitPython_Register
* https://github.com/adafruit/Adafruit_CircuitPython_seesaw
* https://github.com/adafruit/Adafruit_CircuitPython_AM2320
* https://github.com/adafruit/Adafruit_CircuitPython_BNO055
* https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation
* https://github.com/adafruit/Adafruit_CircuitPython_APDS9960

For pypi compatibility, missing setup.py - 6
* https://github.com/adafruit/Adafruit_CircuitPython_CPython
* https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad
* https://github.com/adafruit/Adafruit_CircuitPython_FeatherWing
* https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation
* https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground
* https://github.com/adafruit/Adafruit_CircuitPython_MPL115A2

Not in bundle. - 1
* https://github.com/adafruit/Adafruit_CircuitPython_CPython

ReadTheDocs missing as a subproject on CircuitPython - 1
* https://github.com/adafruit/Adafruit_CircuitPython_CPython

CircuitPython drivers page missing driver - 20
* https://github.com/adafruit/Adafruit_CircuitPython_CPython
* https://github.com/adafruit/Adafruit_CircuitPython_HTU21D
* https://github.com/adafruit/Adafruit_CircuitPython_VEML6075
* https://github.com/adafruit/Adafruit_CircuitPython_MPRLS
* https://github.com/adafruit/Adafruit_CircuitPython_NeoTrellis
* https://github.com/adafruit/Adafruit_CircuitPython_LIDARLite
* https://github.com/adafruit/Adafruit_CircuitPython_miniQR
* https://github.com/adafruit/Adafruit_CircuitPython_MAX31856
* https://github.com/adafruit/Adafruit_CircuitPython_Slideshow
* https://github.com/adafruit/Adafruit_CircuitPython_ADXL34x
* https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation
* https://github.com/adafruit/Adafruit_CircuitPython_CAP1188
* https://github.com/adafruit/Adafruit_CircuitPython_BluefruitSPI
* https://github.com/adafruit/Adafruit_CircuitPython_BMP3XX
* https://github.com/adafruit/Adafruit_CircuitPython_MLX90393
* https://github.com/adafruit/Adafruit_CircuitPython_TFmini
* https://github.com/adafruit/Adafruit_CircuitPython_VS1053
* https://github.com/adafruit/Adafruit_CircuitPython_FRAM
* https://github.com/adafruit/Adafruit_CircuitPython_MPL115A2
* https://github.com/adafruit/Adafruit_CircuitPython_TrellisM4

Not listed on PyPi for CPython use - 8
* https://github.com/adafruit/Adafruit_CircuitPython_CPython
* https://github.com/adafruit/Adafruit_CircuitPython_DS18X20
* https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad
* https://github.com/adafruit/Adafruit_CircuitPython_FeatherWing
* https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation
* https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground
* https://github.com/adafruit/Adafruit_CircuitPython_MLX90393
* https://github.com/adafruit/Adafruit_CircuitPython_MPL115A2

Library repository has no releases. - 1
* https://github.com/adafruit/Adafruit_CircuitPython_CPython

Library has new commits since last release. - 66

New repo(s) currently in work, and unreleased. - 3
* https://github.com/adafruit/Adafruit_CircuitPython_AT86RF233
* https://github.com/adafruit/Adafruit_CircuitPython_SK9822
* https://github.com/adafruit/Adafruit_CircuitPython_US100

README image missing alt text - 1
* https://github.com/adafruit/Adafruit_CircuitPython_HCSR04

ReadTheDocs latest build has warnings and/or errors - 2
* https://github.com/adafruit/Adafruit_CircuitPython_ImageLoad
* https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation

Mismatched readthedocs.yml - 3
* https://github.com/adafruit/Adafruit_CircuitPython_DHT
* https://github.com/adafruit/Adafruit_CircuitPython_DS3231
* https://github.com/adafruit/Adafruit_CircuitPython_GPS

Unable to enable Travis build - 1
* https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation

Much cleaner!

kattni commented 5 years ago

This is wonderful!