Add Support for Changed Spec Identification in spec-gen-sdk-runner tool #32763
Conversation
raych1
requested review from
weshaggard,
mikeharder and
benbp
as code owners
Next Steps to MergeNext steps that must be taken to merge this PR:
|
|
PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
openapi-pipeline-app
bot
added
PipelineBotTrigger
and removed
PipelineBotTrigger
labels
openapi-pipeline-app
bot
added
PipelineBotTrigger
and removed
PipelineBotTrigger
labels
raych1
changed the title
| */ | ||
| export async function resetGitRepo(repoPath: string): Promise<void> { | ||
| try { | ||
| const { stderr } = await execAsync("git clean -fd && git reset --hard HEAD", { |
There was a problem hiding this comment.
| const { stderr } = await execAsync("git clean -fd && git reset --hard HEAD", { | |
| const { stderr } = await execAsync("git clean -fdx && git reset --hard HEAD", { |
Add x so ignored files also get deleted. Will reset HEAD be correct? It will only work if we haven't create a new branch and committed those changes, or do we just need a clean git status?
There was a problem hiding this comment.
'reset' HEAD is needed to remove any modifications to the tracked files.
| const workingFolder = "."; | ||
| const workPath = path.resolve(process.cwd(), workingFolder, options.specFolder, searchPath); | ||
| // Execute the git command using exec | ||
| const { stdout, stderr } = await execAsync(`git ls-tree ${options.treeId} ${workPath}`); |
There was a problem hiding this comment.
Why are we use a git command here instead of just traversing the file system? I would expect by the name of this function we are only looking at the files on disk.
| logMessage("No files changed in the PR"); | ||
| } | ||
| logMessage(`Changed files in the PR: ${prChangedFiles.length}`); | ||
| const fileList = prChangedFiles.filter((p) => !p.includes("/scenarios/")); |
There was a problem hiding this comment.
What is special about "scenarios" here?
There was a problem hiding this comment.
We intend to exclude SDK generation for changes coming from the scenarios folder.
There was a problem hiding this comment.
There are also other paths like examples should those be included? I'm mostly asking this question as it seems a little odd to only figure out this one folder type if what you are looking for is json files.
There was a problem hiding this comment.
Some other file types also need to be included, such as *.tsp, tspconfig.yaml, readme.md.
Changes in the examples folder would need to trigger the automation run because samples would be used in the SDK test/sample generation step. I am not aware of any other folders we might have in the specification folder. I will also add 'specification' to the filter.
| const { stdout: headCommitRaw } = await execAsync("git rev-parse HEAD"); | ||
| const headCommit = headCommitRaw.trim(); // Trim any newline characters | ||
| const { stdout: treeIdRaw } = await execAsync(`git rev-parse ${headCommit}^{tree}`); | ||
| const treeId = treeIdRaw.trim(); |
There was a problem hiding this comment.
Why are we looking at git here? We should just be using the files on disk and assume that repo is correctly checked out.
Major changes are to identify the changed specs to pass into the
spec-gen-sdktool for SDK generation.[
eng/pipelines/templates/stages/archetype-spec-gen-sdk.yml]Updated the
parameterssection to includeUse1ESOfficial: falseand increased the job timeout to 2400 minutes.[
eng/tools/spec-gen-sdk-runner/src/change-files.ts]Introduced a new function
detectChangedSpecConfigFilesto detect changed specification configuration files in a pull request. This function identifies relatedreadme.mdandtspconfig.yamlfiles and logs the changes.[
eng/tools/spec-gen-sdk-runner/src/commands.ts]Added a new function
generateSdkForSpecPrto generate SDKs for specification pull requests.[
eng/tools/spec-gen-sdk-runner/src/utils.ts]Added a new utility function
resetGitRepoto reset unstaged changes in a git repository.@weshaggard can you review these changes?