Maintenance: extract docs/snippets linting in its own CI step

[dreamorosi]

Summary

#1259 introduced changes that allow us to automatically lint the contents of the code snippets present in the docs. When redacting the PR, these checks were conflated as part of the unit tests/linting for the core utilities. This is fine, however if the linting of these code snippets fails, the failure would be opaque for the reviewers as it would appear as part of the main checks (see img below):

Why is this needed?

For a better and more granular at-a-glance view for both maintainers and PR authors, it would be great to have these checks in a separate item/steps so that it's immediately clear where the failure happened.

Which area does this relate to?

Automation

Solution

Update the workflow that runs the tests & linting so that the check is extracted and shows up as a separate item in the PR view:

Acknowledgment

• This request meets Lambda Powertools Tenets
• Should this be considered in other Lambda Powertools languages? i.e. Python, Java

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.