Post Action Registry

Existing Post Actions

Description	ActionID
Restore NuGet packages	210D431B-A78B-4D2F-B762-4ED3E3EA9025
Run script	3A7C4B45-1F5D-4A30-959A-51B88E82B5D2
Open a file in the editor	84C0DA21-51C8-4541-9940-6CA19AF04EE6
Open a file in the web browser	FEA7469E-E2E7-4431-B86B-27EBC1744883
Add a reference to a project file	B17581D1-C5C9-4489-8F0A-004BE667B814
Add projects to a solution file	D396686C-DE0E-4DE6-906D-291CD29FC5DE
Change file permissions (Unix/OS X)	CB9A6CF3-4F5C-4860-B9D2-03A574959774

Restore NuGet packages

Used to restore NuGet packages after project create.

• Action ID : 210D431B-A78B-4D2F-B762-4ED3E3EA9025
• Configuration : None
• Supported in:
  • dotnet new3
  • dotnet new (2.0.0 or higher)
  • Visual Studio 2017.3 Preview 1 (ignored)

Example

"postActions": [{
  "condition": "(!skipRestore)",
  "description": "Restore NuGet packages required by this project.",
  "manualInstructions": [
    { "text": "Run 'dotnet restore'" }
  ],
  "actionId": "210D431B-A78B-4D2F-B762-4ED3E3EA9025",
  "continueOnError": true
}]

Run script

Used to run a script after create.

• Action ID : 3A7C4B45-1F5D-4A30-959A-51B88E82B5D2
• Configuration : There are three required properties that must be specified
  • executable (string): The executable to launch
  • args (string): The arguments to pass to the executable
  • manualInstructions (array): a list of instructions to display if the action cannot be performed
• Supported in:
  • dotnet new3
  • dotnet new (2.0.0 or higher)

The working directory for the launched executable is set to the root of the output template content.

Example

"postActions": [{
    "actionId": "3A7C4B45-1F5D-4A30-959A-51B88E82B5D2",
    "args": {
      "executable": "setup.cmd",
      "args": ""
    },
    "manualInstructions": [{ 
       "text": "Run 'setup.cmd'" 
       }],
    "continueOnError": "false",
    "description ": "setups the project by calling setup.cmd"
  }]

Open a file in the editor

Opens a file in the editor. For command line cases this will be ignored.

• Action ID : 84C0DA21-51C8-4541-9940-6CA19AF04EE6
• Configuration : TBD
• Supported in: TBD

Open a file in the web browser

Opens a file in the users default browser.

• Action ID : FEA7469E-E2E7-4431-B86B-27EBC1744883
• Configuration : TBD
• Supported in: TBD

Add a reference to a project file

• Action ID : B17581D1-C5C9-4489-8F0A-004BE667B814
• Configuration :
  • referenceType (string): Either "package", "project" or "framework"
  • reference (string): The package ID or relative path of the project to add the reference to
  • projectFileExtensions (string) (optional): A semicolon delimited list of literal file extensions to use when searching for the project to add the reference to
• Supported in:
  • dotnet new3 ("framework" is not supported)
  • dotnet new (2.0.0 or higher - "framework" is not supported)
  • Visual Studio 2017.3 Preview 1

Add project(s) to a solution file

• Action ID : D396686C-DE0E-4DE6-906D-291CD29FC5DE
• Configuration :
  • primaryOutputIndexes (string): A semicolon delimited list of indexes to the primary outputs. Note: If primary outputs are conditional, multiple post actions with the same conditions as the primary outputs might be necessary.
• Supported in:
  • dotnet new3
  • dotnet new (2.0.0 or higher)
  • Visual Studio 2017.3 Preview 1 (ignored)

Change file permissions

Unix / OS X only (runs the Unix chmod command).

• Action ID : CB9A6CF3-4F5C-4860-B9D2-03A574959774
• Configuration :
  • args: The permissions to set (see examples). Usually this will contain a glob like { "+x": "*.sh" } or a list of filenames like { "+x": ["script1", "script2"] }
• Supported in: TBD (Was added in https://github.com/dotnet/templating/pull/1042)

Example

"postActions": [{
    "condition": "(OS != \"windows\")",
    "description": "Make scripts executable",
    "manualInstructions": [ ],
    "actionId": "cb9a6cf3-4f5c-4860-b9d2-03a574959774",
    "args": {
        "+x": "*.sh"
    },
    "continueOnError": true
}]

or

"postActions": [{
    "condition": "(OS != \"windows\")",
    "description": "Make scripts executable",
    "manualInstructions": [ ],
    "actionId": "cb9a6cf3-4f5c-4860-b9d2-03a574959774",
    "args": {
        "+x": "*.sh"
    },
    "continueOnError": true
}]