Skip to content

Fix 1908 - Version from API differs from manifest #1911

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+91 −6
Open

Fix 1908 - Version from API differs from manifest #1911

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e898a07
Create workaround with help from Copilot
o-l-a-v Nov 19, 2025
dced0d9
Removed out of place newline
o-l-a-v Nov 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 91 additions & 6 deletions src/code/InstallHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,17 +397,47 @@ private void MoveFilesIntoInstallPath(
string scriptPath)
{
_cmdletPassedIn.WriteDebug("In InstallHelper::MoveFilesIntoInstallPath()");
// Creating the proper installation path depending on whether pkg is a module or script
var newPathParent = isModule ? Path.Combine(installPath, pkgInfo.Name) : installPath;
var finalModuleVersionDir = isModule ? Path.Combine(installPath, pkgInfo.Name, moduleManifestVersion) : installPath;


// Source path
// If script, just move the files over, if module, move the version directory over
var tempModuleVersionDir = (!isModule || isLocalRepo) ? dirNameVersion
string tempModuleVersionDir = (!isModule || isLocalRepo) ? dirNameVersion
: Path.Combine(tempInstallPath, pkgInfo.Name, newVersion);

_cmdletPassedIn.WriteVerbose($"Installation source path is: '{tempModuleVersionDir}'");

// Destination path
// Creating the proper installation path depending on whether pkg is a module or script
string finalModuleVersionDir;
string newPathParent;
string moduleFolderNameToUse = moduleManifestVersion; // default to passed-in value (API pkg version)

// If this is a module, prefer the version declared in the manifest inside the temp extraction
if (isModule)
{
if (TryGetManifestVersionFromTemp(tempModuleVersionDir, pkgInfo.Name, out string manifestVersionFromPsd1))
{
// Use manifest-declared version as the directory name so Import-Module sees the same version string
if (!moduleFolderNameToUse.Equals(manifestVersionFromPsd1)) {
_cmdletPassedIn.WriteVerbose($"Version returned from the repository API '{moduleManifestVersion}' is different from the manifest '{manifestVersionFromPsd1}'. Will use version from the manifest instead for package '{pkgInfo.Name}'.");
moduleFolderNameToUse = manifestVersionFromPsd1;
}
}
else
{
_cmdletPassedIn.WriteVerbose($"Failed to get version from manifest for '{pkgInfo.Name}', will use the version returned from repository API '{moduleManifestVersion}'.");
}

newPathParent = Path.Combine(installPath, pkgInfo.Name);
finalModuleVersionDir = Path.Combine(installPath, pkgInfo.Name, moduleFolderNameToUse);
}
else
{
// Script installs go to the installPath directly
finalModuleVersionDir = newPathParent = installPath;
}
_cmdletPassedIn.WriteVerbose($"Installation destination path is: '{finalModuleVersionDir}'");

// Move files to install path
if (isModule)
{
// If new path does not exist
Expand Down Expand Up @@ -466,7 +496,6 @@ private void MoveFilesIntoInstallPath(
{
_cmdletPassedIn.WriteVerbose("Deleting script metadata XML");
File.Delete(Path.Combine(scriptInfoFolderPath, scriptXML));

}

_cmdletPassedIn.WriteVerbose(string.Format("Moving '{0}' to '{1}'", Path.Combine(dirNameVersion, scriptXML), Path.Combine(installPath, "InstalledScriptInfos", scriptXML)));
Expand Down Expand Up @@ -495,6 +524,62 @@ private void MoveFilesIntoInstallPath(
}


/// <summary>
/// Try to get version from the .psd1 manifest, because API sometimes returns x.y.0, but manifest says version x.y.
/// </summary>
private bool TryGetManifestVersionFromTemp(
string tempModuleVersionDir,
string packageName,
out string manifestVersion)
{
manifestVersion = null;

try
{
// First try the canonical path <tempModuleVersionDir>\<packageName>.psd1
var psd1Path = Path.Combine(tempModuleVersionDir, packageName + PSDataFileExt);

// If not present at canonical location, search recursively for the first .psd1
if (!File.Exists(psd1Path))
{
var found = Directory.GetFiles(tempModuleVersionDir, "*.psd1", SearchOption.AllDirectories).FirstOrDefault();
if (!string.IsNullOrEmpty(found))
{
psd1Path = found;
}
}

if (!File.Exists(psd1Path))
{
return false;
}

var text = File.ReadAllText(psd1Path);

// Try to extract ModuleVersion first, then Version.
var m = Regex.Match(text, @"ModuleVersion\s*=\s*(['""]?)([0-9A-Za-z\.\-\+]+)\1", RegexOptions.IgnoreCase);
if (!m.Success)
{
m = Regex.Match(text, @"Version\s*=\s*(['""]?)([0-9A-Za-z\.\-\+]+)\1", RegexOptions.IgnoreCase);
}

if (m.Success)
{
manifestVersion = m.Groups[2].Value;
return !string.IsNullOrEmpty(manifestVersion);
}

return false;
}
catch (Exception e)
{
// Don't fail install here; just log verbose so we can still fall back to API version.
_cmdletPassedIn.WriteVerbose($"Unable to read manifest version from temp path '{tempModuleVersionDir}': {e.Message}");
manifestVersion = null;
return false;
}
}

/// <summary>
/// Iterates through package names passed in and calls method to install each package and their dependencies.
/// </summary>
Expand Down