Skip to content

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

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

Closed
walmsles opened this issue Aug 4, 2023 · 6 comments
Assignees
Labels
internal Maintenance changes

Comments

@walmsles
Copy link
Contributor

walmsles commented Aug 4, 2023

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
@walmsles walmsles added bug Something isn't working triage Pending triage from maintainers labels Aug 4, 2023
@heitorlessa heitorlessa added internal Maintenance changes and removed bug Something isn't working triage Pending triage from maintainers labels Aug 4, 2023
@heitorlessa heitorlessa changed the title Bug: As a Developer make pr doe snot work due to linting errors in documentation Maintenance: As a Developer make pr doe snot work due to linting errors in documentation Aug 4, 2023
@heitorlessa
Copy link
Contributor

Thanks a lot for raising this @walmsles - sending a PR soon to ignore that rule for that file.

@walmsles
Copy link
Contributor Author

walmsles commented Aug 4, 2023

@heitorlessa can you make sure to ignore both the files, there are 2 (just in case you only did 1)

@heitorlessa
Copy link
Contributor

yeeah, I did both maintainers and validation. I ran make pr locally to be triple sure. Just waiting @leandrodamascena to wake up as he's in a different timezone

@github-actions github-actions bot added the pending-release Fix or implementation already in dev waiting to be released label Aug 4, 2023
@leandrodamascena
Copy link
Contributor

This fix has been pushed to the develop branch. Closing this issue.

@github-project-automation github-project-automation bot moved this from Working on it to Coming soon in Powertools for AWS Lambda (Python) Aug 7, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Aug 7, 2023

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments 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.

@leandrodamascena leandrodamascena moved this from Coming soon to Shipped in Powertools for AWS Lambda (Python) Aug 15, 2023
@github-actions
Copy link
Contributor

This is now released under 2.23.0 version!

@github-actions github-actions bot removed the pending-release Fix or implementation already in dev waiting to be released label Aug 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal Maintenance changes
Projects
Status: Shipped
Development

No branches or pull requests

3 participants