[Merged by Bors] - Enable mdlint in CI#278
[Merged by Bors] - Enable mdlint in CI#278alice-i-cecile wants to merge 38 commits intobevyengine:new-bookfrom
Conversation
|
I feel very seen |
|
@mockersf, the mdlint CI doesn't seem to be ignoring the specified rules. I followed the setup in |
|
I think the |
|
@mockersf, any suggestions on the CI failure for the dead-link checks?
The link itself seems to be dying, but I'm not sure how to fix that on our end. Edit: seems to have been intermittent, and now CI is failing successfully! |
|
So to close this sooner than later, I think we could split this up a bit. Have a PR with the markdownlint stuff only since it's only missing some minor fixes and then in another PR figure out the dead-links stuff |
You're totally correct 😄 I'll do that and then we can merge this in. |
Changing the name of the file in the .github file doesn't work unfortunately.
| sort_by = "weight" | ||
| template = "book-section.html" | ||
| page_template = "book-section.html" | ||
| insert_anchor_links = "right" |
There was a problem hiding this comment.
Wasn't this added in another PR? I'm not sure why this PR adds more of them
There was a problem hiding this comment.
Yeah, this would be a rebasing issue... Let me check if they're duplicated.
There was a problem hiding this comment.
Nope, not duplicated. IDK why this is showing up on Github; let me try rebasing again.
There was a problem hiding this comment.
Rebasing does nothing: Git is weird... Anyways, these aren't duplicated in the resulting file, so I don't think there's an issue.
There was a problem hiding this comment.
Alright, well that's fine then, it doesn't matter that much, I was just a bit surprised to see that.
There was a problem hiding this comment.
It was added in #280. Every single _index.md file needs this so that it is consistent throughout the website. Therefore whenever you add a new _index.md file you would have to add insert_anchor_links at the top of the file. Not sure why there are files highlighted as changed here even though they already have this lint in the new_book branch.
There was a problem hiding this comment.
Yeah, that was my confusion. That PR is already merged, so I don't get why git still shows it as changed. As long as the end result is that we have mdlint and anchors everywhere I'm happy.
|
bors r+ |
|
Merge conflict. |
|
bors r+ |
- Fixes #207 # Status - [x] Split the PR - [x] Merge #272 (do first to reduce dumb merge conflicts). - [x] Fix all mdlint violations - [x] Update CI to target `master` rather than `main` (or fix the branch name per #140 ) - [x] Add local rules to ignore the same lints to improve contributor experience. I followed [these instructions](https://github.com/DavidAnson/vscode-markdownlint#configure); simply renaming the version in the .github folder didn't resolve the problem for me.
|
Pull request successfully merged into new-book. Build succeeded: |
Status
masterrather thanmain(or fix the branch name per Change master branch to main #140 )