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

Markdown Linting Github Action #250

Closed
wants to merge 13 commits into from
Closed

Conversation

@github-actions
Copy link

github-actions bot commented Aug 21, 2022

Visit the preview URL for this PR (updated for commit e16ab62):

https://fetch-docs-preview--pr250-feat-md-linting-acti-vjfm0vlx.web.app

(expires Wed, 14 Sep 2022 17:33:38 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

5A11
5A11 previously approved these changes Sep 8, 2022
Copy link
Member

@5A11 5A11 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@5A11 5A11 dismissed their stale review September 8, 2022 16:02

Missed CI failure

@5A11
Copy link
Member

5A11 commented Sep 8, 2022

@VijaySharma815 please address the CI failures.

@5A11
Copy link
Member

5A11 commented Sep 9, 2022

Add automated listing of markdown files in the script that generates the reference API.
Add automated listing of markdown files in MakeFile as a separate command and as part of make lint.

@VijaySharma815 VijaySharma815 added the S-do-not-merge Status: This pull request is NOT ready to be merged label Sep 12, 2022
@VijaySharma815
Copy link
Contributor Author

I found the python package but it's inactive:
https://github.com/jorisroovers/pymarkdownlint

also, it uses click 4.1 which is incompatible with many of our library:

ERROR: safety 2.1.1 has requirement Click>=8.0.2, but you'll have click 4.1 which is incompatible.
ERROR: pydoc-markdown 4.6.3 has requirement click<9.0,>=7.1, but you'll have click 4.1 which is incompatible.
ERROR: mkdocs 1.3.1 has requirement Markdown<3.4,>=3.2.1, but you'll have markdown 3.4.1 which is incompatible.
ERROR: black 22.6.0 has requirement click>=8.0.0, but you'll have click 4.1 which is incompatible.

@VijaySharma815
Copy link
Contributor Author

@5A11 In this PR I already did linting:
https://github.com/fetchai/cosmpy/pull/180/files

@solarw solarw mentioned this pull request Sep 14, 2022
@solarw
Copy link
Contributor

solarw commented Sep 14, 2022

@VijaySharma815
please take a look.
#279

make docs-check and make docs-format commands are added
md files are not formatted, so please take a look is auto formatting good for you

@5A11
Copy link
Member

5A11 commented Sep 15, 2022

This tool requires the introduction of a heavy dependency, either npm and associated JS dependencies, or docker. For such an optional tool, such a move is not justified.

For now, a standard python tool is preferred.

@VijaySharma815 VijaySharma815 mentioned this pull request Sep 20, 2022
3 tasks
@5A11 5A11 deleted the feat/md_linting_action branch December 24, 2022 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-do-not-merge Status: This pull request is NOT ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants