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

Add Markdown linting to pre-commit #11465

Merged
merged 1 commit into from
Nov 10, 2020
Merged

Conversation

jbampton
Copy link
Member

  • Add a basic config file
  • Lint Markdown

https://www.npmjs.com/package/markdownlint-cli


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.

@turbaszek
Copy link
Member

@jbampton can you please check if it would be possible to add this tool to pre-commit config? In this way, files will be linted before commit and this speeds up the feedback loop.

@potiuk
Copy link
Member

potiuk commented Oct 13, 2020

Seems that this is even added in the original markdown lint repo - so should be super easy to add ot our .pre-commit-config.yml

https://github.com/markdownlint/markdownlint/blob/master/.pre-commit-hooks.yaml

@ashb ashb requested a review from potiuk October 19, 2020 10:07
@ashb ashb added area:CI Airflow's tests and continious integration and removed area:dev-tools area:helm-chart Airflow Helm Chart labels Oct 19, 2020
@potiuk
Copy link
Member

potiuk commented Oct 19, 2020

Any news about pre-commit version of the markdown lint @jbampton ?

@mik-laj
Copy link
Member

mik-laj commented Oct 24, 2020

@jbampton do you need any help?

@jbampton jbampton changed the title Add a GitHub action to lint the Markdown files Add Markdown linting to pre-commit Oct 24, 2020
@github-actions
Copy link

The Workflow run is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks$,^Build docs$,^Spell check docs$,^Backport packages$,^Checks: Helm tests$,^Test OpenAPI*.

@github-actions
Copy link

The Workflow run is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks$,^Build docs$,^Spell check docs$,^Backport packages$,^Checks: Helm tests$,^Test OpenAPI*.

@jbampton
Copy link
Member Author

Hey @turbaszek @potiuk @mik-laj this PR is ready for review 👍

@mik-laj mik-laj merged commit 7463b6b into apache:master Nov 10, 2020
@mik-laj
Copy link
Member

mik-laj commented Nov 10, 2020

Awesome! Can you create an issue about the remaining rules (similar to #10742) ?

@jbampton jbampton deleted the markdownlint branch November 10, 2020 02:44
potiuk pushed a commit that referenced this pull request Nov 14, 2020
@potiuk potiuk added this to the Airflow 1.10.13 milestone Nov 14, 2020
@potiuk potiuk added the type:misc/internal Changelog: Misc changes that should appear in change log label Nov 14, 2020
potiuk pushed a commit that referenced this pull request Nov 16, 2020
potiuk pushed a commit that referenced this pull request Nov 16, 2020
kaxil pushed a commit that referenced this pull request Nov 18, 2020
cfei18 pushed a commit to cfei18/incubator-airflow that referenced this pull request Mar 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:CI Airflow's tests and continious integration type:misc/internal Changelog: Misc changes that should appear in change log
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants