Skip to content

Commit 64d2d37

Browse files
committed
refactor: Rename file contents to use the new repo and module name
1 parent 167cb6e commit 64d2d37

File tree

7 files changed

+20
-20
lines changed

7 files changed

+20
-20
lines changed

.github/workflows/build-and-test-powershell-module.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ on:
3131
value: ${{ jobs.build-and-test.outputs.deployFilesArtifactName }}
3232

3333
env:
34-
powerShellModuleName: 'Template.PowerShell.ScriptModule'
35-
powerShellModuleDirectoryPath: './src/Template.PowerShell.ScriptModule'
34+
powerShellModuleName: 'ScriptModuleRepositoryTemplate'
35+
powerShellModuleDirectoryPath: './src/ScriptModuleRepositoryTemplate'
3636
deployFilesDirectoryPath: './deploy'
3737
prereleaseModuleArtifactName: 'PrereleaseModuleArtifact'
3838
prereleaseModuleArtifactDirectoryPath: './artifacts/Prerelease'

ReadMe.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Template PowerShell Script Module Repository
1+
# PowerShell Script Module Repository Template
22

33
🚧 This repo is still a work in progress and not yet ready to be used 🚧
44

@@ -31,14 +31,14 @@ There are two ways to create your new PowerShell module repository:
3131
Both of these methods are described in more detail below.
3232

3333
Once the repository is created, follow the instructions in the repo's ReadMe file to complete the setup.
34-
The non-transformed instructions can also be [viewed here](/src/Template.PowerShell.ScriptModule/TemplateRepoFiles/ReadMe.md).
34+
The non-transformed instructions can also be [viewed here](/src/ScriptModuleRepositoryTemplate/TemplateRepoFiles/ReadMe.md).
3535

3636
## 📂 Method 1: Use the New-PowerShellScriptModuleRepository cmdlet
3737

38-
Step 1: Install the `Template.PowerShell.ScriptModule` module from the PowerShell Gallery:
38+
Step 1: Install the `ScriptModuleRepositoryTemplate` module from the PowerShell Gallery:
3939

4040
```powershell
41-
Install-Module -Name Template.PowerShell.ScriptModule -Scope CurrentUser
41+
Install-Module -Name ScriptModuleRepositoryTemplate -Scope CurrentUser
4242
```
4343

4444
Step 2: Create the new repository files:
@@ -89,10 +89,10 @@ You can derive your own template from this repository and use it for your future
8989

9090
To create your own template:
9191

92-
1. Fork [this repository on GitHub](https://github.com/deadlydog/Template.PowerShell.ScriptModule).
92+
1. Fork [this repository on GitHub](https://github.com/deadlydog/PowerShell.ScriptModuleRepositoryTemplate).
9393
1. In GitHub, from your repo's `Settings` tab under the `General` section, rename the repository to reflect that it is a template and check the box to make it a `Template repository`.
94-
1. Modify [the template repo files](/src/Template.PowerShell.ScriptModule/TemplateRepoFiles/) with whatever customizations you want.
95-
1. If you are introducing more replacement tokens in the files, you will need to update the `Set-TemplateTokenValuesInAllRepositoryFiles` function in the [Template.PowerShell.ScriptModule.psm1](/src/Template.PowerShell.ScriptModule/Template.PowerShell.ScriptModule.psm1) file to handle them.
94+
1. Modify [the template repo files](/src/ScriptModuleRepositoryTemplate/TemplateRepoFiles/) with whatever customizations you want.
95+
1. If you are introducing more replacement tokens in the files, you will need to update the `Set-TemplateTokenValuesInAllRepositoryFiles` function in the [ScriptModuleRepositoryTemplate.psm1](/src/ScriptModuleRepositoryTemplate/ScriptModuleRepositoryTemplate.psm1) file to handle them.
9696

9797
You can now create new repositories from your GitHub template in the same way you would use this one.
9898

_InitializeRepository.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ If you have made changes to any files you may want to commit them before continu
1717
Write-Information "Creating the template repository files."
1818
Import-Module -Name $TemplateModuleDirectoryPath -Force
1919
New-PowerShellScriptModuleRepository -RepositoryDirectoryPath $RepositoryDirectoryPath -ModuleName $moduleName -OrganizationName $organizationName
20-
Remove-Module -Name Template.PowerShell.ScriptModule -Force
20+
Remove-Module -Name ScriptModuleRepositoryTemplate -Force
2121

2222
Write-Information "Removing the template module files since we are done using it to create the template repository files."
2323
Remove-TemplateModuleFiles -templateModuleDirectoryPath $TemplateModuleDirectoryPath
@@ -29,7 +29,7 @@ Begin
2929
{
3030
$InformationPreference = 'Continue'
3131
[string] $RepositoryDirectoryPath = Resolve-Path -Path $PSScriptRoot
32-
[string] $TemplateModuleDirectoryPath = "$RepositoryDirectoryPath\src\Template.PowerShell.ScriptModule"
32+
[string] $TemplateModuleDirectoryPath = "$RepositoryDirectoryPath\src\ScriptModuleRepositoryTemplate"
3333

3434
function Remove-AllRepositoryFilesExceptTemplateModuleFiles([string] $repositoryDirectoryPath)
3535
{

deploy/Invoke-SmokeTests.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
# To run these tests on your local machine, see the comments in the BeforeAll block.
66

77
BeforeAll {
8-
Import-Module -Name 'Template.PowerShell.ScriptModule' -Force
8+
Import-Module -Name 'ScriptModuleRepositoryTemplate' -Force
99

1010
# To run these tests on your local machine, comment out the Import-Module command above and uncomment the one below.
1111
# Do this to use the module version from source code, not the installed version.
1212
# This is necessary to test functionality that you've added to the module, but have not yet published and installed.
13-
# Import-Module "$PSScriptRoot\..\src\Template.PowerShell.ScriptModule" -Force
13+
# Import-Module "$PSScriptRoot\..\src\ScriptModuleRepositoryTemplate" -Force
1414
}
1515

1616
Describe 'New-PowerShellScriptModuleRepository' {

src/ScriptModuleRepositoryTemplate/ScriptModuleRepositoryTemplate.Tests.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using module './Template.PowerShell.ScriptModule.psm1'
1+
using module './ScriptModuleRepositoryTemplate.psm1'
22

33
Describe 'New-PowerShellScriptModuleRepository' {
44
It 'Should create a new directory with the module repository files' {

src/ScriptModuleRepositoryTemplate/ScriptModuleRepositoryTemplate.psd1

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
@{
44

55
# Script module or binary module file associated with this manifest.
6-
RootModule = 'Template.PowerShell.ScriptModule.psm1'
6+
RootModule = 'ScriptModuleRepositoryTemplate.psm1'
77

88
# Version number of this module.
99
ModuleVersion = '0.0.0'
@@ -27,7 +27,7 @@
2727
Description = @'
2828
This module does nothing, but is part of a template git repository that you can clone to create new PowerShell script modules quickly and easily with boilerplate files and CI/CD workflows already defined.
2929
30-
Checkout the template repository at https://github.com/deadlydog/Template.PowerShell.ScriptModule.
30+
Checkout the template repository at https://github.com/deadlydog/PowerShell.ScriptModuleRepositoryTemplate.
3131
'@
3232

3333
# Minimum version of the PowerShell engine required by this module
@@ -110,16 +110,16 @@ Checkout the template repository at https://github.com/deadlydog/Template.PowerS
110110
)
111111

112112
# A URL to the license for this module.
113-
LicenseUri = 'https://github.com/deadlydog/Template.PowerShell.ScriptModule/blob/main/License.md'
113+
LicenseUri = 'https://github.com/deadlydog/PowerShell.ScriptModuleRepositoryTemplate/blob/main/License.md'
114114

115115
# A URL to the main website for this project.
116-
ProjectUri = 'https://github.com/deadlydog/Template.PowerShell.ScriptModule'
116+
ProjectUri = 'https://github.com/deadlydog/PowerShell.ScriptModuleRepositoryTemplate'
117117

118118
# A URL to an icon representing this module.
119119
# IconUri = ''
120120

121121
# ReleaseNotes of this module
122-
ReleaseNotes = 'Changelog: https://github.com/deadlydog/Template.PowerShell.ScriptModule/blob/main/Changelog.md'
122+
ReleaseNotes = 'Changelog: https://github.com/deadlydog/PowerShell.ScriptModuleRepositoryTemplate/blob/main/Changelog.md'
123123

124124
# Prerelease string of this module
125125
# Prerelease = ''

src/ScriptModuleRepositoryTemplate/ScriptModuleRepositoryTemplate.psm1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ function New-PowerShellScriptModuleRepository
3333
It creates a new directory with the module repository files.
3434
3535
.LINK
36-
https://github.com/deadlydog/Template.PowerShell.ScriptModule
36+
https://github.com/deadlydog/PowerShell.ScriptModuleRepositoryTemplate
3737
#>
3838
[CmdletBinding()]
3939
[Alias('New-PSRepository')]

0 commit comments

Comments
 (0)