arduino / actions

Collection of custom Github actions
Other
34 stars 6 forks source link

libraries/compile-examples: discourage use of legacy API in documentation #71

Closed per1234 closed 4 years ago

per1234 commented 4 years ago

The original design of the action was extremely limiting and so the API was expanded to allow the action to become a flexible, general purpose tool for compilation testing of Arduino sketches.

The old API format continues to be supported, but deprecated. Toward the goal of discouraging the use of the old API in new workflows, the documentation should only mention the new API, or if it is necessary to mention the old API (as is the case with the libraries input due to the significant differences in behavior when the new API is used vs. the old), it should be clearly stated that this is deprecated.