Skip to content

Maintenance: As a Developer make pr doe snot work due to linting errors in documentation #2919

Closed
@walmsles

Description

@walmsles

Expected Behaviour

make pr is reporting on markdown linting errors in my dev environment (maybe its just me?) and not allowing me to continue with make pr and being a good pull request citizen for powertools. Need some help here?

Current Behaviour

$> make pr
poetry run black aws_lambda_powertools tests examples
All done! ✨ 🍰 ✨
349 files left unchanged.
poetry run ruff aws_lambda_powertools tests examples
docker run -v /Users/walmlses/dev/open-source/aws-lambda-powertools-python:/markdown 06kellyjac/markdownlint-cli "docs"
WARNING: The requested image's platform (linux/amd64) does not match the detected host platform (linux/arm64/v8) and no specific platform was requested
docs/maintainers.md:293:381 MD013/line-length Line length [Expected: 380; Actual: 395]
docs/utilities/validation.md:116:381 MD013/line-length Line length [Expected: 380; Actual: 401]
make: *** [lint-docs] Error 1

Code snippet

No Code required.

Possible Solution

Unsure - the actual documentation lines already have <!-- markdownlint-disable-next-line MD013 --> above them but are not working when I run make pr` ?

Steps to Reproduce

make pr

Powertools for AWS Lambda (Python) version

latest

AWS Lambda function runtime

3.7

Packaging format used

PyPi

Debugging logs

poetry run black aws_lambda_powertools tests examples
All done! ✨ 🍰 ✨
349 files left unchanged.
poetry run ruff aws_lambda_powertools tests examples
docker run -v /Users/walmlses/dev/open-source/aws-lambda-powertools-python:/markdown 06kellyjac/markdownlint-cli "docs"
WARNING: The requested image's platform (linux/amd64) does not match the detected host platform (linux/arm64/v8) and no specific platform was requested
docs/maintainers.md:293:381 MD013/line-length Line length [Expected: 380; Actual: 395]
docs/utilities/validation.md:116:381 MD013/line-length Line length [Expected: 380; Actual: 401]
make: *** [lint-docs] Error 1

Metadata

Metadata

Assignees

Labels

internalMaintenance changes

Type

No type

Projects

Status

Shipped

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions