microsoft / microsoft/sbom-tool

[Microsoft.Sbom.Targets] Rename internal MSBuild properties to minimize risk of conflicts

Open
#800 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

.NET help wanted
Dominant language
C#
Stars
2.1k
Forks
201
Avg merge
6d 21h
Merged PRs (30d)
1

Description

In the Microsoft.Sbom.Targets NuGet package, the MSBuild properties UnzipGuid, ShortUnzipGuidFolder, and NugetPackageUnzip should preferably be renamed to something that includes "Sbom", to minimise the risk of conflicts with properties used for other purposes.

But I wonder how necessary a random number even is here. Perhaps the value of $(NugetPackageUnzip) could be just something like $(IntermediateOutputPath)sbom.tmp with no randomness at all. That change might make the unzipped files less likely to exceed the Windows PATH_MAX limit, too.

Originally posted by @KalleOlaviNiemitalo in https://github.com/microsoft/sbom-tool/issues/693#issuecomment-2341843427

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating Microsoft.Sbom.Targets and the definitions or uses of UnzipGuid, ShortUnzipGuidFolder, and NugetPackageUnzip. Determine whether the properties should be Sbom-prefixed, whether the random value can be removed, and verify that the package still produces the expected unzipped files and build behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
build-system
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.