Skip to content
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

chore: Add a deprecation warning to config/boards #2811

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Nick-Munnich
Copy link
Contributor

Thought it was about time for at least a warning to be spat out. My suggestion would be that after some more time we make using config/boards spit out an error that can be lifted with an extra cmake argument, but I think we should have a warning message first.

PR check-list

  • Branch has a clean commit history
  • Additional tests are included, if changing behaviors/core code that is testable.
  • Proper Copyright + License headers added to applicable files (Generally, we stick to "The ZMK Contributors" for copyrights to help avoid churn when files get edited)
  • Pre-commit used to check formatting of files, commit messages, etc.
  • Includes any necessary documentation changes.

@Nick-Munnich Nick-Munnich requested a review from a team as a code owner February 3, 2025 17:15
@caksoylar
Copy link
Contributor

I think it'd be better to be more explicit here, someone who doesn't follow ZMK might not even know what a "module" is, given this warning will be emitted by GH Actions where config repo == module. Is there a docs page we can link to?

@Nick-Munnich Nick-Munnich force-pushed the config-deprecation-warning branch from 1387498 to 3d5bde5 Compare February 15, 2025 00:39
@Nick-Munnich
Copy link
Contributor Author

With #2456 merged I have now updated this with a link to the appropriate docs page.

@caksoylar
Copy link
Contributor

I think the new shield guide might be more straight-forward to link to, given the module creation page might be a bit overwhelming for people who just want to use a custom shield. Maybe we can add both, with new shield first, what do you think?

@Nick-Munnich Nick-Munnich force-pushed the config-deprecation-warning branch from 3d5bde5 to 3868daa Compare February 16, 2025 23:47
@Nick-Munnich
Copy link
Contributor Author

Good idea, made that change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants