-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Add snippets 5000 check #6982
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 snippets 5000 check #6982
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding this!
@danmoseley FYI we're adding a status check to this repo that builds any code snippets that are modified. But if the code snippet isn't associated with a project file, then you'll see a (non-blocking) error that asks you to add a project file. |
Docs Build status updates of commit 0aeebda: ✅ Validation status: passed
For more details, please refer to the build report. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. For any questions, please:
|
@gewarren nice. I'm forgetting any context here. has the engineering team typically provided snippets (at least in recent times)? do we know how to offer new ones? |
@danmoseley I don't think there have been many code snippets (which are short examples that live in the dotnet/dotnet-api-docs repo) or samples (which are more complex examples that live in the dotnet/samples repo) contributed by the engineering team in recent times. But I am fairly new to the team. @BillWagner could maybe provide more insight into that. The overall guidelines are here. This was more just an FYI that there will be a new status check if someone changes any code snippets, and they will likely have to add a new project file to the repo. |
just curious, why is a project file helpful? if it's important, maybe if I add an entirely new snippet, it could block if it isn't in a project (new or existing)? |
Snippets 5000 uses the project file to build the snippet. And yes, it will fail if you add a new snippet that's not part of a project. |
Summary