Skip to content

Change 'CompatPowerShellGet' to 'PowerShellGet' #41

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.

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

Merged
merged 7 commits into from
Sep 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 12 additions & 11 deletions .ci/releaseBuild.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# The name of the build that will be seen in mscodehub
name: CompatPowerShellget-Release-$(Build.BuildId)
name: PowerShellGet-Release-$(Build.BuildId)

# how is the build triggered
# since this is a release build, no trigger as it's a manual release
trigger: none
Expand Down Expand Up @@ -38,7 +39,7 @@ stages:
- ImageOverride -equals PSMMS2019-Secure
jobs:
- job: Build_Job
displayName: Build Microsoft.PowerShell.CompatPowerShellGet
displayName: Build Microsoft.PowerShell.PowerShellGet
# note the variable reference to ESRP.
# this must be created in Project -> Pipelines -> Library -> VariableGroups
# where it describes the link to the SigningServer
Expand All @@ -49,14 +50,14 @@ stages:

# these are setting vso variables which will be persisted between stages
- pwsh: |
$signSrcPath = "$(Build.SourcesDirectory)/CompatPowerShellGet/src"
$signSrcPath = "$(Build.SourcesDirectory)/PowerShellGet/src"
dir
# Set signing src path variable
$vstsCommandString = "vso[task.setvariable variable=signSrcPath]${signSrcPath}"
Write-Host "sending " + $vstsCommandString
Write-Host "##$vstsCommandString"

$signOutPath = "$(Build.SourcesDirectory)/OSS_Microsoft_CompatPowerShellGet/signed/CompatPowerShellGet"
$signOutPath = "$(Build.SourcesDirectory)/OSS_Microsoft_CompatPowerShellGet/signed/PowerShellGet"
$null = New-Item -ItemType Directory -Path $signOutPath
# Set signing out path variable
$vstsCommandString = "vso[task.setvariable variable=signOutPath]${signOutPath}"
Expand All @@ -69,7 +70,7 @@ stages:
Write-Host "##$vstsCommandString"

# Get version and create a variable
$moduleData = Import-PowerShellDataFile "$(Build.SourcesDirectory)/CompatPowerShellGet/src/CompatPowerShellGet.psd1"
$moduleData = Import-PowerShellDataFile "$(Build.SourcesDirectory)/PowerShellGet/src/PowerShellGet.psd1"
$moduleVersion = $moduleData.ModuleVersion
$vstsCommandString = "vso[task.setvariable variable=moduleVersion]${moduleVersion}"
Write-Host "sending " + $vstsCommandString
Expand Down Expand Up @@ -118,7 +119,7 @@ stages:

- pwsh: |
$nupkgPath = "$(localRepo)"
$artifactName = "CompatPowerShellGet"
$artifactName = "PowerShellGet"
Write-Host "##vso[artifact.upload containerfolder=$artifactName;artifactname=$artifactName;]$nupkgPath"
displayName: Upload module artifact

Expand All @@ -141,7 +142,7 @@ stages:
- template: script-module-compliance.yml@ComplianceRepo
parameters:
# component-governance - the path to sources
sourceScanPath: '$(Build.SourcesDirectory)/CompatPowerShellGet'
sourceScanPath: '$(Build.SourcesDirectory)/PowerShellGet'
# TermCheck
optionsRulesDBPath: ''
optionsFTPath: ''
Expand All @@ -160,26 +161,26 @@ stages:
- ImageOverride -equals PSMMS2019-Secure
jobs:
- job: Publish_Job
displayName: Build Microsoft.PowerShell.CompatPowerShellGet
displayName: Build Microsoft.PowerShell.PowerShellGet
steps:
- checkout: self

- task: DownloadPipelineArtifact@2
displayName: 'Download PowerShellGet module artifacts'
inputs:
artifact: CompatPowerShellGet
artifact: PowerShellGet
patterns: '**/*.nupkg'
downloadPath: '$(Pipeline.Workspace)/nuget'

- pwsh: |
$package = (Get-ChildItem '$(Pipeline.Workspace)/nuget/CompatPowerShellGet.*.nupkg').FullName
$package = (Get-ChildItem '$(Pipeline.Workspace)/nuget/PowerShellGet.*.nupkg').FullName
$vstsCommandString = "vso[task.setvariable variable=NugetPkgPath]${package}"
Write-Host "sending " + $vstsCommandString
Write-Host "##$vstsCommandString"
displayName: 'Capture PowerShellGet module NuGet package path and set environment variable'

- task: NuGetCommand@2
displayName: 'Push CompatPowerShellGet module artifacts to PSGallery feed'
displayName: 'Push PowerShellGet module artifacts to PSGallery feed'
inputs:
command: push
packagesToPush: '$(NugetPkgPath)'
Expand Down
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# Changelog
### 0.9.0

### 0.0.4
* Changes
- Update module to be compatible with latest version of PowerShellGet (3.0.21-beta21)

### 0.0.3
* Changes
- Updated reference to PowerShellGet 'Url' parameter to 'Uri' to reflect changes made in PowerShellGet
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# CompatPowerShellGet
# PowerShellGet

[![PowerShell Gallery - CompatPowerShellGet](https://img.shields.io/badge/PowerShell%20Gallery-PowerShellGet-blue.svg)](https://www.powershellgallery.com/packages/CompatPowerShellGet)
[![Minimum Supported PowerShell Version](https://img.shields.io/badge/PowerShell-3.0-blue.svg)](https://github.com/PowerShell/CompatPowerShellGet)
[![PowerShell Gallery - PowerShellGet](https://img.shields.io/badge/PowerShell%20Gallery-PowerShellGet-blue.svg)](https://www.powershellgallery.com/packages/PowerShellGet)
[![Minimum Supported PowerShell Version](https://img.shields.io/badge/PowerShell-5.1-blue.svg)](https://github.com/PowerShell/PowerShellGet)


Introduction
============
CompatPowerShellGet is a compatibility module that allows use of PowerShellGet 2.x (and below) cmdlet syntax with PowerShellGet 3.0 (and newer) functionality by making a best effort mapping between the cmdlet interfaces of both versions of the module.'
PowerShellGet v3 is a compatibility module that allows use of PowerShellGet 2.x (and below) cmdlet syntax with PSResourceGet functionality by making a best effort mapping between the cmdlet interfaces of both versions of the module.'

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
Expand All @@ -16,39 +16,39 @@ questions or comments.
Documentation
=============

Documentation for CompatPowerShellGet has not yet been published, please
Documentation for PowerShellGet has not yet been published, please
[Click here](https://docs.microsoft.com/powershell/module/PowerShellGet/?view=powershell-7)
to reference the documentation for previous versions of PowerShellGet.

Requirements
============

- Windows PowerShell 3.0 or newer.
- Windows PowerShell 5.1 or newer.
- PowerShell Core.


Get CompatPowerShellGet Module
Get PowerShellGet Module
========================

Please refer to our [documentation](https://www.powershellgallery.com/packages/CompatPowerShellGet/) for the up-to-date version on how to get the CompatPowerShellGet Module.
Please refer to our [documentation](https://www.powershellgallery.com/packages/PowerShellGet/) for the up-to-date version on how to get the PowerShellGet Module.


Get PowerShellGet Source
========================

#### Steps
* Obtain the source
- Download the latest source code from the release page (https://github.com/PowerShell/CompatPowerShellGet/releases) OR
- Download the latest source code from the release page (https://github.com/PowerShell/PowerShellGet/releases) OR
- Clone the repository (needs git)
```powershell
git clone https://github.com/PowerShell/CompatPowerShellGet
git clone https://github.com/PowerShell/PowerShellGet
```
* Navigate to the source directory
```powershell
cd path/to/CompatPowerShellGet
cd path/to/PowerShellGet
```

* Import the module
```powershell
Import-Module src/CompatPowerShellGet
Import-Module src/PowerShellGet -Force
```
6 changes: 3 additions & 3 deletions SignConfig.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<!-- Config files for Azure DevOps code-signing pipeline. -->
<SignConfigXML>
<!-- AnyCPU Release sign job -->
<job platform="AnyCPU" configuration="Release" dest="__OUTPATHROOT__\signed" jobname="CompatPowerShellGet" approvers="vigarg;gstolt">
<file src="__INPATHROOT__\src\CompatPowerShellGet.psd1" signType="AuthenticodeFormer" dest="__OUTPATHROOT__\CompatPowerShellGet.psd1" />
<file src="__INPATHROOT__\src\CompatPowerShellGet.psm1" signType="AuthenticodeFormer" dest="__OUTPATHROOT__\CompatPowerShellGet.psm1" />
<job platform="AnyCPU" configuration="Release" dest="__OUTPATHROOT__\signed" jobname="PowerShellGet" approvers="vigarg;gstolt">
<file src="__INPATHROOT__\src\PowerShellGet.psd1" signType="AuthenticodeFormer" dest="__OUTPATHROOT__\PowerShellGet.psd1" />
<file src="__INPATHROOT__\src\PowerShellGet.psm1" signType="AuthenticodeFormer" dest="__OUTPATHROOT__\PowerShellGet.psm1" />
</job>
</SignConfigXML>
16 changes: 9 additions & 7 deletions src/CompatPowerShellGet.psd1 → src/PowerShellGet.psd1
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
#
# Module manifest for module 'CompatPowerShellGet'
# Module manifest for module 'PowerShellGet'
#
# Generated by: americks
#
# Generated on: 7/14/2020
#

@{
RootModule = 'CompatPowerShellGet.psm1'
ModuleVersion = '0.0.4'
RootModule = 'PowerShellGet.psm1'
ModuleVersion = '0.9.0'
GUID = '68ec3ec1-55bf-42f8-9add-d224e5c76548'
Author = 'Microsoft Corporation'
CompanyName = 'Microsoft Corporation'
Copyright = '(c) Microsoft Corporation. All rights reserved.'
Description = 'CompatPowerShellGet is a compatibility module that allows use of PowerShellGet 2.x (and below) cmdlet syntax with PowerShellGet 3.0 (and newer) functionality by making a best effort mapping between the cmdlet interfaces of both versions of the module.'
Description = 'PowerShellGet is a compatibility module that allows use of PowerShellGet 2.x (and below) cmdlet syntax with PSResourceGet functionality by making a best effort mapping between the cmdlet interfaces of both versions of the module.'
PowerShellVersion = '3.0'
FunctionsToExport = @(
"Find-Command",
Expand Down Expand Up @@ -51,9 +51,11 @@
'Mac',
'Windows')

LicenseUri = 'https://github.com/PowerShell/CompatPowerShellGet/blob/master/LICENSE'
ProjectUri = 'https://github.com/PowerShell/CompatPowerShellGet'
LicenseUri = 'https://github.com/PowerShell/PowerShellGet/blob/master/LICENSE'
ProjectUri = 'https://github.com/PowerShell/PowerShellGet'
ReleaseNotes = @'
### 0.9.0

### 0.0.4
* Changes
- Update module to be compatible with latest version of PowerShellGet (3.0.21-beta21)
Expand All @@ -70,7 +72,7 @@
* Initial release

## For full history of release notes see changelog:
https://github.com/PowerShell/CompatPowerShellGet/blob/master/CHANGELOG.md
https://github.com/PowerShell/PowerShellGet/blob/master/CHANGELOG.md
'@
}
}
Expand Down
File renamed without changes.