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

Exclude all markdown files from triggering CI #68221

Merged
merged 10 commits into from
Apr 20, 2022
Merged

Conversation

ViktorHofer
Copy link
Member

Since 08/09/2021 it's now possible to use wild cards in exclusion patterns: https://docs.microsoft.com/en-us/azure/devops/release-notes/2021/sprint-192-update#support-for-wild-cards-in-path-filters.

Fixing our exclude yml statements to ignore all markdown files in the repo and not just the ones under docs/.

Since 08/09/2021 it's now possible to use wild cards in exclusion patterns: https://docs.microsoft.com/en-us/azure/devops/release-notes/2021/sprint-192-update#support-for-wild-cards-in-path-filters.

Fixing our exclude yml statements to ignore all markdown files in the repo and not just the ones under docs/.
@ghost
Copy link

ghost commented Apr 19, 2022

Tagging subscribers to this area: @dotnet/area-infrastructure-libraries
See info in area-owners.md if you want to be subscribed.

Issue Details

Since 08/09/2021 it's now possible to use wild cards in exclusion patterns: https://docs.microsoft.com/en-us/azure/devops/release-notes/2021/sprint-192-update#support-for-wild-cards-in-path-filters.

Fixing our exclude yml statements to ignore all markdown files in the repo and not just the ones under docs/.

Author: ViktorHofer
Assignees: ViktorHofer
Labels:

area-Infrastructure-libraries

Milestone: -

@ViktorHofer ViktorHofer marked this pull request as ready for review April 19, 2022 16:03
Copy link
Member

@danmoseley danmoseley left a comment

Choose a reason for hiding this comment

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

This assumes that .md do not participate in any build steps. Seems like a safe assumption unless anyone knows otherwise.

@ViktorHofer
Copy link
Member Author

Usually other text formats like .TXT are used as part of the build. I don't think a markdown file contributes in any way to the build and I don't think that we yet have any component in our build that validates markdown files. Ie nuget packages can include markdown files and they theoretically are an input to the Pack target but they aren't validated so it's likely not necessary to run CI for them.

@danmoseley
Copy link
Member

but they aren't validated so it's likely not necessary to run CI for them.

If I delete a .md that's such an input, could that break the build? If so then after this PR that break would no longer be detected.

@AustinWise
Copy link
Contributor

There appears to be some files whose extension end with .md but are not actually markdown. For example:

https://github.com/dotnet/runtime/blob/main/src/mono/mono/tests/metadata-verifier/cli-cattr-tests.md

It looks like the "md" stands for "metadata". I'm not familiar with the Mono build system, so I could not figure out if these are being used or not.

@danmoseley
Copy link
Member

Oh - such a simple check I didn't think to do. Here's the full list of problematic ones:

src\mono\mono\mini\cpu-amd64.md
src\mono\mono\mini\cpu-arm.md
src\mono\mono\mini\cpu-arm64.md
src\mono\mono\mini\cpu-ppc.md
src\mono\mono\mini\cpu-ppc64.md
src\mono\mono\mini\cpu-riscv32.md
src\mono\mono\mini\cpu-riscv64.md
src\mono\mono\mini\cpu-s390x.md
src\mono\mono\mini\cpu-wasm.md
src\mono\mono\mini\cpu-x86.md
src\mono\mono\tests\metadata-verifier\cli-blob-tests.md
src\mono\mono\tests\metadata-verifier\cli-cattr-tests.md
src\mono\mono\tests\metadata-verifier\cli-global-props-tests.md
src\mono\mono\tests\metadata-verifier\cli-header-tests.md
src\mono\mono\tests\metadata-verifier\cli-metadata-tests.md
src\mono\mono\tests\metadata-verifier\cli-tables-tests.md
src\mono\mono\tests\metadata-verifier\data-directory-tests.md
src\mono\mono\tests\metadata-verifier\header-tests.md
src\mono\mono\tests\metadata-verifier\resources-tests.md
src\mono\mono\tests\metadata-verifier\section-table-tests.md

@akoeplinger do you know whether we can change their extensions, and if so, is there a matching code change to make?

@akoeplinger
Copy link
Member

Yes that should be possible, I opened #68239

@ViktorHofer ViktorHofer merged commit 76e9996 into main Apr 20, 2022
@ViktorHofer ViktorHofer deleted the ViktorHofer-patch-3 branch April 20, 2022 06:41
directhex pushed a commit to directhex/runtime that referenced this pull request Apr 21, 2022
directhex pushed a commit to directhex/runtime that referenced this pull request Apr 21, 2022
* Exclude all markdown files from triggering CI

Since 08/09/2021 it's now possible to use wild cards in exclusion patterns: https://docs.microsoft.com/en-us/azure/devops/release-notes/2021/sprint-192-update#support-for-wild-cards-in-path-filters.

Fixing our exclude yml statements to ignore all markdown files in the repo and not just the ones under docs/.
@ghost ghost locked as resolved and limited conversation to collaborators May 20, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants