techthoughts2 / psgalleryexplorer Goto Github PK

Description

Include the clone url in the ProjectInfo results if a module has a corresponding git project

Describe the solution you'd like

When results are returned and a module has a corresponding git project, the git clone url willbe included in ProjectInfo

Description

Dear PSGalleryExplorer users,

I wanted to let you know about an issue that PSGalleryExplorer is currently facing. PSGalleryExplorer extends PowerShell Gallery Module search functionality by including information about a module's associated repository.

The number of modules on the PowerShell Gallery has grown to a level that is no longer scalable with the current serverless workflow that PSGalleryExplorer has in place. This necessitates a re-architecture of the way that the repository information is collected and served through AWS cloudfront.

As a result of this change, the current AWS CDN endpoint that PSGalleryExplorer is using will be lost. This means that PSGalleryExplorer will cease to function properly. Current users, that have already downloaded the latest updated repository information, will have that information on their local device. It will grow stale until such time that PSGalleryExplorer is repaired. New users will be unable to use the current version of the module at all.

When PSGalleryExplorer is fixed, any older version of the module will not have context of the new CDN endpoint, and thus, will be unable to download the updated repository information.

I am actively working on repairing PSGalleryExplorer at this time, but it will take some time to complete the re-architecture. I wanted to be transparent with you about this issue and let you know what is going on. I apologize for any inconvenience this may cause.

Thank you for your patience and understanding. If you have any questions or concerns, please feel free to reach out.

Best regards,

@techthoughts2

Description

Currently, when using PSGalleryExplorer to retrieve metadata for a PowerShell module, the last updated field is based on information from the PowerShell Gallery. However, there may be cases where the module's repository has more up-to-date information on when it was last updated. This can lead to inconsistencies, where the module's last updated date in the gallery is not accurate.

As an example, consider the PSLeap module. The last updated field in the PowerShell Gallery metadata is January 28th, 2023. However, the module's repository shows that it hasn't been updated since June 8th, 2022. This is likely because the repository hasn't been updated, but the PowerShell Gallery metadata was updated for some other reason. This inconsistency can be confusing for users who are trying to determine the actual last updated date of the module.

$a.AdditionalMetadata

summary                   : A PowerShell smart filesystem bookmarking tool.
isLatestVersion           : True
published                 : 6/8/2022 3:05:41 PM +01:00
lastUpdated               : 1/28/2023 2:43:41 AM +00:00
SourceName                : PSGallery
created                   : 6/8/2022 3:05:41 PM +01:00
description               : A PowerShell smart filesystem bookmarking tool.

vs

$a.ProjectInfo       

Name                           Value
----                           -----
Updated                        06/08/22 15:05:23
Created                        06/08/22 05:49:21
Forks                          0
Issues                         0

Describe the solution you'd like

In the case of the PSLeap module, the last updated field should be based on the repository's information, rather than the PowerShell Gallery's information. This will ensure that the last updated field is accurate and consistent with the module's repository. If the repository doesn't have a last updated field, then the PowerShell Gallery's last updated field can be used as a fallback.

Describe any alternatives you've considered

One alternative solution would be to always prioritize the PowerShell Gallery's last updated field, regardless of whether the repository has more up-to-date information. However, this can lead to inconsistencies as mentioned before, and can be confusing for users who are trying to determine the actual last updated date of the module.

Additional context

This feature request is being made in response to inconsistencies observed between the last updated field in the PowerShell Gallery metadata and the repository information for the PSLeap module. Prioritizing the last updated field from the repository will help to ensure that the information in PSGalleryExplorer is accurate and consistent with the module's repository.

Description

If possible, return the size of the module as one of the parameters in the results

Describe the solution you'd like

A query should return the size (on disk) of modules