Enable markdownlint check in CI #2773
Conversation
And clean up to get to green Closes #1852
| @@ -0,0 +1,21 @@ | |||
| name: Markdownlint | |||
|
|
|||
| on: pull_request | |||
There was a problem hiding this comment.
You can filter this with the "paths" so it only runs if affected files are touched. The latest version has an example of that https://github.com/dotnet/docs/blob/ab63ef519c0cd889fffb6b243a4bb85720eb5d29/.github/workflows/markdownlint.yml
There was a problem hiding this comment.
Is it worth it, considering that we tell markdownlint what to exclude anyway below? If this would be just about not running the check at all for EF6 changes...
Co-authored-by: Nick Schonning <nschonni@gmail.com>
| @@ -188,7 +188,7 @@ You can use the string overload of `HasForeignKey(...)` to configure a shadow pr | |||
|
|
|||
| #### Foreign key constraint name | |||
|
|
|||
| By convention, when targeting a relational database, foreign key constraints are named FK_<dependent type name>_<principal type name>_<foreign key property name>. For composite foreign keys <foreign key property name> becomes an underscore separated list of foreign key property names. | |||
| By convention, when targeting a relational database, foreign key constraints are named FK\_\<dependent type name>\_\<principal type name>\_\<foreign key property name>`. For composite foreign keys, \<foreign key property name> becomes an underscore separated list of foreign key property names. | |||
There was a problem hiding this comment.
| By convention, when targeting a relational database, foreign key constraints are named FK\_\<dependent type name>\_\<principal type name>\_\<foreign key property name>`. For composite foreign keys, \<foreign key property name> becomes an underscore separated list of foreign key property names. | |
| By convention, when targeting a relational database, foreign key constraints are named FK\_\<dependent type name>\_\<principal type name>\_\<foreign key property name>. For composite foreign keys, \<foreign key property name> becomes an underscore separated list of foreign key property names. |
|
Noooo! 😢 |
|
What? What did I do? |
|
|
|
I've exercised executive powers and pushed a commit to fix the world. |
|
@roji might take a look later, but FYI, you can now auto-fix some rules in markdownlint. They're listed as "Fixable" in https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
|
|
@nschonni oh nice, didn't know that. I think that for our remaining suppressions, some decision-making is typically required - but I'll give it a try. |
Same as how it's done in dotnet/docs - thanks @nschonni @mairaw! This adds an additional check for linting. IIRC we don't currently block merging on failed checks in this repo, so we can treat this as informative warnings if we want (though it's a good idea to start paying attention to it and keeping things clean).
Also cleaned up existing issues.
Closes #1852