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

Fix broken links #223

Merged
merged 1 commit into from
Jan 15, 2022
Merged

Fix broken links #223

merged 1 commit into from
Jan 15, 2022

Conversation

bmish
Copy link
Collaborator

@bmish bmish commented Jan 6, 2022

  • Fixed a handful of broken links, detected them using markdown-link-check
  • Switched http links to https

@@ -3,7 +3,6 @@
[![NPM version](https://img.shields.io/npm/v/eslint-plugin-qunit.svg?style=flat)](https://npmjs.org/package/eslint-plugin-qunit)
![CI](https://github.com/platinumazure/eslint-plugin-qunit/workflows/CI/badge.svg)
[![Coverage Status](https://coveralls.io/repos/platinumazure/eslint-plugin-qunit/badge.svg?branch=master&service=github)](https://coveralls.io/github/platinumazure/eslint-plugin-qunit?branch=master)
[![devDependency Status](https://david-dm.org/platinumazure/eslint-plugin-qunit/dev-status.svg)](https://david-dm.org/platinumazure/eslint-plugin-qunit#info=devDependencies)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Removed this broken badge.

@coveralls
Copy link

coveralls commented Jan 6, 2022

Coverage Status

Coverage remained the same at 100.0% when pulling 6d10363 on bmish:fix-links into f6d96fa on platinumazure:master.

Copy link
Owner

@platinumazure platinumazure left a comment

Choose a reason for hiding this comment

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

Is it easy to get those checks into CI?

@bmish
Copy link
Collaborator Author

bmish commented Jan 6, 2022

@platinumazure that would be nice, although note there's a risk that external link breakages could block PR builds then.

If we want to do this, we could add a lint:links script in package.json. But the problem is the CLI for this tool doesn't support specifying multiple files nor globs currently so it's not really practical to run on all of our docs using the CLI right now. Blocked by:

A github action could be an alternative: https://github.com/gaurav-nelson/github-action-markdown-link-check

@platinumazure platinumazure merged commit 19320ff into platinumazure:master Jan 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants