Update the parameters of a moduleForge project
update-mfProject [[-ModuleName] <String>] [[-description] <String>] [[-minimumPsVersion] <Version>]
[[-moduleAuthors] <String[]>] [[-companyName] <String>] [[-moduleTags] <String[]>] [[-projectUri] <String>]
[[-iconUri] <String>] [[-licenseUri] <String>] [[-RequiredModules] <Object[]>]
[[-ExternalModuleDependencies] <String[]>] [[-DefaultCommandPrefix] <String[]>] [[-PrivateData] <Object[]>]
[[-path] <String>] [[-configFile] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
This command allows you to update any of the parameters that were saved with the new-mfProject function without having to recreate the whole project file from scratch.
update-mfProject -ModuleName "UpdatedModule" -description "An updated description for the module" -moduleAuthors "Jane Doe" -companyName "UpdatedCompany" -moduleTags "updated", "module" -projectUri "https://github.com/username/updated-repo" -iconUri "https://example.com/updated-icon.png" -licenseUri "https://example.com/updated-license" -RequiredModules @("UpdatedModule1", "UpdatedModule2") -ExternalModuleDependencies @("UpdatedDependency1", "UpdatedDependency2") -DefaultCommandPrefix "UpdMod" -PrivateData @{}
This example demonstrates how to use the `update-mfProject` function to update multiple parameters of an existing module project. It updates the module name, description, authors, company name, tags, project URI, icon URI, license URI, required modules, external module dependencies, default command prefix, and private data.
The function will update the specified parameters in the module project configuration file.
update-mfProject -ModuleName "UpdatedModule" -description "An updated description for the module"
This example demonstrates how to use the `update-mfProject` function to update only the module name and description of an existing module project. It leaves all other parameters unchanged.
The function will update the module name and description in the module project configuration file.
The name of your module
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
A description of your module. Is used as the descriptor in the module repository
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Minimum PowerShell version. Defaults to 7.2 as this is the current LTS version
Type: Version
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Who are the primary module authors. Can expand later with add-mfmoduleAuthors command
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Company Name. If you are building this module for your organisation, this is where it goes
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Module Tags. Used to help discoverability and compatibility in package repositories
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Source Code Repository to use, i.e. your repositories github/azure devops uri
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
A URL to an icon representing this module.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
URI to use for your projects license. Will try and use the license file if a projectUri is found
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Modules that must be imported into the global environment prior to importing this module
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Modules that must be imported into the global environment prior to importing this module
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
If you are specifying a Default Command Prefix via your manifest, this will update that prefix
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
If you have any additional Private Data you want to add to your module manifest, add it here
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 13
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Root path of the module. Uses the current working directory by default
Type: String
Parameter Sets: (All)
Aliases: modulePath
Required: False
Position: 14
Default value: $(get-location).path
Accept pipeline input: False
Accept wildcard characters: False
Module Config File
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 15
Default value: ModuleForgeConfig.xml
Accept pipeline input: False
Accept wildcard characters: False
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Author: Adrian Andersson