add next steps#11990
Merged
Merged
Conversation
github-actions
Bot
added
the
azsdk-cli
benbp
approved these changes
Sep 8, 2025
l0lawrence
requested review from
jeo02,
maririos,
praveenkuttappan,
richardpark-msft,
samvaity,
scbedd,
smw-ms and
timovv
as code owners
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive next steps guidance to the package validation tool by introducing a NextSteps property to check responses and providing specific remediation instructions for different validation failures.
- Adds tracking of failed checks and generates contextual next steps for users
- Provides specific guidance for each validation type (dependency, changelog, README, spelling)
- Enhances the overall check response with consolidated next steps from individual checks
maririos
reviewed
Sep 9, 2025
| if (overallSuccess) | ||
| { | ||
| nextSteps.Add("All package validation checks passed! Your package is ready for the next steps in the development process."); | ||
| nextSteps.Add("Consider running package release readiness checks if preparing for release."); |
Member
There was a problem hiding this comment.
shouldn't this be always mandatory?
maririos
reviewed
Sep 9, 2025
| "Review and update the CHANGELOG.md file to ensure it follows the proper format", | ||
| "Verify that unreleased changes are properly documented", | ||
| "Check that version numbers and release dates are correctly formatted", | ||
| "Refer to the Azure SDK changelog guidelines for proper formatting" |
Member
There was a problem hiding this comment.
should this point to the guidelines for the changelog?
maririos
reviewed
Sep 9, 2025
| result.NextSteps = new List<string> | ||
| { | ||
| "Create or update the README.md file to include required sections", | ||
| "Ensure the README follows Azure SDK documentation standards", |
Member
There was a problem hiding this comment.
same comment as abouve about providing the link
maririos
reviewed
Sep 9, 2025
| "Create or update the README.md file to include required sections", | ||
| "Ensure the README follows Azure SDK documentation standards", | ||
| "Include proper installation instructions, usage examples, and API documentation links", | ||
| "Verify that all code samples in the README are working and up-to-date" |
Member
There was a problem hiding this comment.
what does a sample working means?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.