public/ps-module-giteautilities
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity

Bump module version to 1.5.0 and update Invoke-GiteaFileDownload and Get-GiteaChildItem functions to use 'Result' instead of 'Success' for status reporting, and add OverwriteByHash parameter for conditional file overwriting.
Some checks failed
Publish Powershell Module to Gitea Repository / test (push) Failing after 10s
Details
Publish Powershell Module to Gitea Repository / deploy (push) Has been skipped
Details

Browse Source
This commit is contained in:
Raymond LaRose
2025-05-27 13:14:28 -04:00
parent ed9ba80938
commit 67d69c52e9
2 changed files with 43 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
PS-GiteaUtilities/PS-GiteaUtilities.psd1
View File

@@ -12,7 +12,7 @@
RootModule = 'PS-GiteaUtilities.psm1' RootModule = 'PS-GiteaUtilities.psm1'
# Version number of this module. # Version number of this module.
ModuleVersion = '1.4.5' ModuleVersion = '1.5.0'
# Supported PSEditions # Supported PSEditions
# CompatiblePSEditions = @() # CompatiblePSEditions = @()

56
PS-GiteaUtilities/PS-GiteaUtilities.psm1
View File

@@ -207,7 +207,7 @@ Function Get-GiteaFileContent {
Content = $content Content = $content
Size = $fileContent.size Size = $fileContent.size
SHA = $fileContent.sha SHA = $fileContent.sha
Success = $true Result = 'Success'
Error = $null Error = $null
} }
} }
@@ -218,7 +218,7 @@ Function Get-GiteaFileContent {
Content = $null Content = $null
Size = $null Size = $null
SHA = $null SHA = $null
Success = $false Result = 'Failure'
Error = $_.Exception.Message Error = $_.Exception.Message
} }
} }
@@ -336,6 +336,9 @@ Function Invoke-GiteaFileDownload {
If used without specifying an outputPath, creates the directory structure in the current location. If used without specifying an outputPath, creates the directory structure in the current location.
If used with outputPath, treats the outputPath as the base directory to append the relative path to. If used with outputPath, treats the outputPath as the base directory to append the relative path to.
Cannot be used with outputName. Cannot be used with outputName.
.PARAMETER OverwriteByHash
A switch parameter to overwrite the file if it exists based on its hash.
.PARAMETER force .PARAMETER force
A switch parameter to force overwriting of an existing file at the output path. A switch parameter to force overwriting of an existing file at the output path.
@@ -344,6 +347,10 @@ Function Invoke-GiteaFileDownload {
The type of the item to download (file, dir, lfs). This parameter is typically used with pipeline input from Get-GiteaChildItem. The type of the item to download (file, dir, lfs). This parameter is typically used with pipeline input from Get-GiteaChildItem.
Directories will be skipped with a verbose message. Directories will be skipped with a verbose message.
.PARAMETER sha
The SHA of the file to download. This parameter is typically used with pipeline input from Get-GiteaChildItem.
Can be combined with OverwriteByHash to overwrite an existing file if the hashes do not match.
.EXAMPLE .EXAMPLE
# Example 1: Download a file to the current directory # Example 1: Download a file to the current directory
Invoke-GiteaFileDownload -downloadURL "https://gitea.example.com/api/v1/repos/owner/repo/raw/path/to/file.txt" -token "your_token" Invoke-GiteaFileDownload -downloadURL "https://gitea.example.com/api/v1/repos/owner/repo/raw/path/to/file.txt" -token "your_token"
@@ -375,9 +382,12 @@ Function Invoke-GiteaFileDownload {
[Parameter(ValueFromPipelineByPropertyName)] [Parameter(ValueFromPipelineByPropertyName)]
[string]$outputName, [string]$outputName,
[switch]$PreserveRelativePath, [switch]$PreserveRelativePath,
[switch]$OverwriteByHash,
[switch]$force, [switch]$force,
[Parameter(ValueFromPipelineByPropertyName)] [Parameter(ValueFromPipelineByPropertyName)]
[string]$type [string]$type,
[Parameter(ValueFromPipelineByPropertyName)]
[string]$sha
) )
begin { begin {
@@ -424,7 +434,7 @@ Function Invoke-GiteaFileDownload {
return [PSCustomObject]@{ return [PSCustomObject]@{
SourceURL = $downloadURL SourceURL = $downloadURL
Type = $type Type = $type
Success = $true Result = 'Success'
Error = "Skipped - item is a directory" Error = "Skipped - item is a directory"
Timestamp = Get-Date Timestamp = Get-Date
FileSize = $null FileSize = $null
@@ -438,7 +448,7 @@ Function Invoke-GiteaFileDownload {
return [PSCustomObject]@{ return [PSCustomObject]@{
SourceURL = $downloadURL SourceURL = $downloadURL
Type = $type Type = $type
Success = $false Result = 'Failure'
Error = $errorMsg Error = $errorMsg
Timestamp = Get-Date Timestamp = Get-Date
FileSize = $null FileSize = $null
@@ -511,17 +521,35 @@ Function Invoke-GiteaFileDownload {
Path = $fileOutputPath Path = $fileOutputPath
SourceURL = $downloadURL SourceURL = $downloadURL
Type = "file" Type = "file"
Success = $false Result = 'Failure'
Error = $null Error = $null
Timestamp = Get-Date Timestamp = Get-Date
FileSize = $null FileSize = $null
} }
if((Test-Path -Path $fileOutputPath -PathType Leaf) -and (-not $force)) { if((Test-Path -Path $fileOutputPath -PathType Leaf) -and (-not $force)) {
$errorMsg = "The file '$fileOutputPath' already exists. Use the -Force switch to overwrite the file." # Check if OverwriteByHash is set
Write-Error $errorMsg if ($OverwriteByHash) {
$result.Error = $errorMsg Write-Verbose "OverwriteByHash is set; checking file hash for existing file: $fileOutputPath"
return $result $existingFileHash = (Get-FileHash -Path $fileOutputPath -Algorithm SHA256).Hash
$downloadFileHash = $sha
if ($existingFileHash -eq $downloadFileHash) {
Write-Host "The file '$fileOutputPath' already exists and hashes match. Skipping download."
$result.Result = 'Skipped'
return $result
}
else {
Write-Host "The file '$fileOutputPath' already exists but hashes do not match and OverwriteByHash is set; overwriting file."
}
}
else {
$errorMsg = "The file '$fileOutputPath' already exists. Use the -Force switch to overwrite the file."
Write-Error $errorMsg
$result.Error = $errorMsg
return $result
}
} }
try { try {
@@ -546,7 +574,7 @@ Function Invoke-GiteaFileDownload {
$result.FileSize = $fileInfo.Length $result.FileSize = $fileInfo.Length
} }
$result.Success = $true $result.Result = 'Success'
return $result return $result
} }
catch { catch {
@@ -756,7 +784,7 @@ Function Get-GiteaChildItem {
size = $item.size size = $item.size
sha = $item.sha sha = $item.sha
downloadURL = $item.download_url downloadURL = $item.download_url
Success = $true Result = 'Success'
Error = $null Error = $null
Level = 0 Level = 0
} }
@@ -839,7 +867,7 @@ Function Get-GiteaChildItem {
size = $subItem.size size = $subItem.size
sha = $subItem.sha sha = $subItem.sha
downloadURL = $subItem.download_url downloadURL = $subItem.download_url
Success = $true Result = 'Success'
Error = $null Error = $null
Level = $currentLevel Level = $currentLevel
} }
@@ -886,7 +914,7 @@ Function Get-GiteaChildItem {
size = $null size = $null
sha = $null sha = $null
downloadURL = $null downloadURL = $null
Success = $false Result = 'Failure'
Error = $_.Exception.Message Error = $_.Exception.Message
Level = 0 Level = 0
} }