Skip to content

Conversation

@jbampton
Copy link
Member

We could use this CI to check if links in markdown files are alive.


^ 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.

@jbampton jbampton force-pushed the markdown-link-checker branch from b70d3d4 to cf08b76 Compare November 10, 2020 05:49
@jbampton
Copy link
Member Author

This needs more work but all the dead links are listed here:

https://github.com/apache/airflow/pull/12226/checks?check_run_id=1378135549

Copy link
Member

@potiuk potiuk left a comment

Choose a reason for hiding this comment

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

We have strong preference for adding such checks in pre-commit rather than in Github Actions - because it then makes it possible to run such checks much earlier in the development process. adding new jobs/workflow in GA is heavy and it's very difficult to reproduce it locally.

We are using the fantastic https://pre-commit.com framework and we already have ~ 60 pre-commit checks added this way. I am quite sure someone has already released markdown link checker and even if not, it should be very easy to add it to the pre-commit framework.

You have all information about pre-commits here: https://github.com/apache/airflow/blob/master/STATIC_CODE_CHECKS.rst

@stale
Copy link

stale bot commented Dec 25, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale Stale PRs per the .github/workflows/stale.yml policy file label Dec 25, 2020
@github-actions github-actions bot closed this Mar 1, 2021
@jbampton jbampton deleted the markdown-link-checker branch January 31, 2023 03:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:dev-tools stale Stale PRs per the .github/workflows/stale.yml policy file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants