Skip to content

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

Merged
merged 1 commit into from
Aug 4, 2021
Merged

Add snippets 5000 check #6982

merged 1 commit into from
Aug 4, 2021

Conversation

adegeo
Copy link
Contributor

@adegeo adegeo commented Aug 4, 2021

Summary

  • Enables the Snippets 5000 build check

@adegeo adegeo requested a review from a team as a code owner August 4, 2021 19:41
@ghost ghost added the area-Infrastructure label Aug 4, 2021
Copy link
Contributor

@gewarren gewarren left a 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!

@adegeo adegeo enabled auto-merge (squash) August 4, 2021 20:02
@gewarren
Copy link
Contributor

gewarren commented Aug 4, 2021

@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.

@opbld34
Copy link

opbld34 commented Aug 4, 2021

Docs Build status updates of commit 0aeebda:

✅ Validation status: passed

File Status Preview URL Details
.github/workflows/build-validation.yml ✅Succeeded
.github/workflows/dependencies/Get-MSBuildResults.ps1 ✅Succeeded
.github/workflows/dependencies/Out-GithubActionStatus.ps1 ✅Succeeded
.github/workflows/dependencies/run-dotnet-whatsnew.sh ✅Succeeded

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:

@adegeo adegeo merged commit d87e550 into main Aug 4, 2021
@adegeo adegeo deleted the snippets branch August 4, 2021 20:10
@danmoseley
Copy link
Member

@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?

@gewarren
Copy link
Contributor

gewarren commented Aug 4, 2021

@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.

@danmoseley
Copy link
Member

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)?

@gewarren
Copy link
Contributor

gewarren commented Aug 5, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants