adafruit / circuitpython-org

CircuitPython's website
https://circuitpython.org
155 stars 577 forks source link

Add Board Filename Matches Board ID Check #1012

Open makermelissa opened 2 years ago

makermelissa commented 2 years ago

An easy way to avoid stuff like #1010 would be to have it check that the board_id matches the filename. This will probably need some valid exceptions added like unknown though. Also, this would need to take the board_alias filed into account.

FoamyGuy commented 3 weeks ago

I started this on a branch here: https://github.com/FoamyGuy/circuitpython-org/tree/check_boardid_filename

One thing that we'll need to decide is if / how to deal with the ones that are already merged in and would not pass this check, here is the current list:

# core: 
board_id filename mismatch: thingpulse_pendrive_s3 != ThingPulse_PendriveS3
board_id filename mismatch: adafruit_feather_rp2040_rfm != adafruit_feather_rp2040_rfm69
board_id filename mismatch: challenger_rp2350_bconnect != challenger_rp350_bconnect
board_id filename mismatch: challenger_rp2350_wifi6_ble5 != challenger_rp350_wifi6_ble5
board_id filename mismatch: circuitart_zero_s3 != circuitart_esp32s3_zero
board_id filename mismatch: crcibernetica-ideaboard != crcibernetica_ideaboard
board_id filename mismatch: flipperzero_wifi_dev != flipper-zero_wifi_devboard
board_id filename mismatch: heiafr_picomo_v2 != picomo_v2
board_id filename mismatch: seeed_xiao_esp32_s3_sense != seeed_xiao_esp32s3_sense
board_id filename mismatch: devkit_xg24_brd2601b != silabs_devkit_xg24_brd2601b
board_id filename mismatch: explorerkit_xg24_brd2703a != silabs_explorerkit_xg24_brd2703a
board_id filename mismatch: sparkfun_thingplus_matter_mgm240p_brd2704a != sparkfun_thing_plus_matter_mgm240p
board_id filename mismatch: unexpectedmaker_feathers3 != unexpectedmaker_feather3

# blinka:
board_id filename mismatch: adafruit_feather_rp2040_rfm != adafruit_feather_rp2040_rfm69
board_id filename mismatch: nanopi_neo != nanopi_neo_h3
board_id filename mismatch: raspberry_pi_3bplus != raspberry_pi_3b