Skip to content

Commit aca6e48

Browse files
committed
Update README and update module to 1.1.2
1 parent 8635b8f commit aca6e48

File tree

2 files changed

+25
-15
lines changed

2 files changed

+25
-15
lines changed

README.md

+25-15
Original file line numberDiff line numberDiff line change
@@ -35,40 +35,44 @@ Import-Module F:\Repos\ForEvolve.Scripts\dotnet-new\dual-projects\dual-projects.
3535

3636
### How to install from MyGet
3737

38-
You can also use my published version, on MyGet, by executing the following commands:
38+
You can also use the published version, on MyGet, by executing the following commands:
3939

40-
Register my NuGet feed as `ForEvolveFeed`:
40+
Register ForEvolve NuGet feed as `ForEvolveFeed`:
4141

4242
```powershell
4343
Import-Module PowerShellGet
4444
$PSGalleryPublishUri = 'https://www.myget.org/F/forevolve/api/v2/package'
4545
$PSGallerySourceUri = 'https://www.myget.org/F/forevolve/api/v2'
4646
Register-PSRepository -Name ForEvolveFeed -SourceLocation $PSGallerySourceUri -PublishLocation $PSGalleryPublishUri
47+
48+
# If you trust my feed, you can run the following command to get rid of the anoying confirmation
49+
# You will need an elevated PowerShell terminal
50+
Set-PSRepository -Name "ForEvolveFeed" -InstallationPolicy Trusted
4751
```
4852

4953
Install the module from that custom MyGet feed:
5054

5155
```powershell
52-
# for all users/as admin
53-
Install-Module -Name "dual-projects" -RequiredVersion "1.0.0" -Repository ForEvolveFeed
56+
# For all users (required an elevated terminal)
57+
Install-Module -Name "dual-projects" -RequiredVersion "1.1.1" -Repository ForEvolveFeed
5458
55-
# only for the current user
56-
Install-Module -Name "dual-projects" -RequiredVersion "1.0.0" -Repository ForEvolveFeed -Scope CurrentUser
59+
# Only for the current user
60+
Install-Module -Name "dual-projects" -RequiredVersion "1.1.1" -Repository ForEvolveFeed -Scope CurrentUser
5761
```
5862

59-
Finally, import the module:
63+
You may also have to import the module:
6064

6165
```powershell
62-
Import-Module dual-projects.psm1
66+
Import-Module dual-projects
6367
```
6468

65-
You may need update your execution policy, with `Set-ExecutionPolicy`, to be able to run PowerShell script file using the following command:
69+
You may need to update your execution policy, with `Set-ExecutionPolicy`, to be able to run PowerShell script file using the following command:
6670

6771
```powershell
6872
Set-ExecutionPolicy Unrestricted
6973
```
7074

71-
_You need to run PowerShell in admin mode to execute that command._
75+
> You need to run PowerShell in admin mode to execute that command.
7276
7377
### `Add-DualProjects` function
7478

@@ -166,7 +170,7 @@ Add-FunctionalTests -p SomeCoolProject -props ..\FunctionalTests.Build.props
166170

167171
> This will add `<Import Project="..\FunctionalTests.Build.props" />` at the top of the project file ( under `<Project Sdk="Microsoft.NET.Sdk.Web">`).
168172
169-
## Other info
173+
## Other info (notes to self)
170174

171175
Use a custom MyGet feed:
172176

@@ -178,16 +182,19 @@ Register-PSRepository -Name ForEvolveFeed -SourceLocation $PSGallerySourceUri -P
178182
179183
# To unregister a source
180184
Unregister-PSRepository -Name ForEvolveFeed
185+
186+
# To trust the source
187+
Set-PSRepository -Name "ForEvolveFeed" -InstallationPolicy Trusted
181188
```
182189

183190
Install the module from that custom MyGet feed:
184191

185192
```powershell
186193
# Only for the current user
187-
Install-Module -Name "dual-projects" -RequiredVersion "1.1.1" -Repository MyGetFeed -Scope CurrentUser
194+
Install-Module -Name "dual-projects" -RequiredVersion "1.1.1" -Repository ForEvolveFeed -Scope CurrentUser
188195
189196
# For all users (required an elevated terminal)
190-
Install-Module -Name "dual-projects" -RequiredVersion "1.1.1" -Repository MyGetFeed
197+
Install-Module -Name "dual-projects" -RequiredVersion "1.1.1" -Repository ForEvolveFeed
191198
192199
# Update the module (force is required to overrite the old version)
193200
Update-Module -Name "dual-projects" -RequiredVersion "1.1.1" -Force
@@ -199,8 +206,6 @@ Get-InstalledModule -Name "dual-projects"
199206
Uninstall-Module -Name "dual-projects" -AllVersions
200207
```
201208

202-
## Other info (notes to self)
203-
204209
Publish to that custom MyGet feed:
205210

206211
```powershell
@@ -215,6 +220,11 @@ Create a module manifest: `New-ModuleManifest -Path dual-projects.psd1`
215220

216221
# Release Notes
217222

223+
## 1.1.2
224+
225+
- Update the module description.
226+
- Specify `FunctionsToExport` at the module level.
227+
218228
## 1.1.1
219229

220230
- Fix: Convert the _csproj_ file path to absolute before reading it to make sure it works everytime.
-4.55 KB
Binary file not shown.

0 commit comments

Comments
 (0)