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 link check to precommit hooks #2319

Closed
wants to merge 6 commits into from

Conversation

chriselion
Copy link
Contributor

Automates part of the release process. Expecting this to fail in the short term; need to whitelist some things (like localhost:6006 for tensorboard)

@@ -32,7 +32,7 @@ TensorFlow),让游戏开发者和业余爱好者能够轻松地
**除了安装和使用说明外,如需更多信息,
请参阅我们的[文档主页](docs/Readme.md)。**如果您使用的
是 v0.3 之前的 ML-Agents 版本,强烈建议您参考
我们的[关于迁移到 v0.3 的指南](/docs/Migrating.md)。
我们的[关于迁移到 v0.3 的指南](../../../docs/Migrating.md)。
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ervteng @unityjeffrey Let me know what you think about this - to "officially" get the link checker running, we need to have the links from the localized docs point somewhere, because they doc they do point to hasn't been localized. I figure this is better since it's at least explicit in the markdown that it's linking somewhere outside the localization.

Alternative is just whitelist the localized docs and skip the checks on then.

@chriselion
Copy link
Contributor Author

To run full check locally:
git ls-files | grep \.md$ | grep -v localized | xargs -n1 -t markdown-link-check -c markdown-link-check.config.json
This currently only checks a subset of files - pre-commit splits them into batches, but markdown-link-check only runs on the first file in the batch (because it doesn't take multiple files as arguments).

@chriselion
Copy link
Contributor Author

Summary:

@chriselion chriselion closed this Jul 24, 2019
@chriselion chriselion deleted the develop-link-check branch September 12, 2019 22:14
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 18, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant