-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Board names changed to be valid python identifiers #6979
Conversation
I am very confused as to why the usb id check failed.. I did |
Looks like the PR needs to changed PS this script might be one place to add enforcement of the policy for board names to only be valid Python identifiers. |
also it looks like at least one "-" is left after this, boards/espressif_kaluga_1-3/board.c |
I will try to create a |
I was thinking the ci_check_duplicate script could just have it added, but a separate step/script is fine too. |
There is an board alias mechanism which could be used to ease the transition, though I'm not sure if it would produce multiple picture entries in circuitpython.org. It's also true that the old names are used in the directory tree structure in S3: https://adafruit-circuit-python.s3.amazonaws.com/index.html?prefix=bin. If we rename the directories there, we need to track down any links besides the ones in circuitpython-org. There may be many in the Learn Guides. If we are going to do a big renaming, we might also consider renaming the older adafruit boards that don't have I a bit worried whether there's too much churn created by this. One can always take the given board name and substitute |
I am going to make this a draft while we cogitate on this. |
I think a CI check for new boards is best. Is there tooling that needs the python identifier property for all boards? |
We discussed closing draft issues that are stuck in the CircuitPython meeting on 2022-11-28 in In the Weeds. Closing for now. Can be reopened. Tracking in issue #7267, which will remain open. |
This PR is a followup to #6856.
Basically I replaced all "-" and "." with "_".
As for the 8086_commander, I opted to just swap the words around.
Additional requirements for this change to go well:
I will do that pr if you decide to go ahead with this.
8.0.0
releases.Because the board names will remain unchanged on
7.x
.should be in place to prevent boards from having invalid python identifiers as their name.
Fixes #7267.