Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Remove .NET 6/7 zone pivots #43720

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+2 −3,045
Open

Remove .NET 6/7 zone pivots #43720

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b0d8778
remove .net 6/7 zone pivots
gewarren Nov 22, 2024
c3fd4bd
removed duplicated code snippets
gewarren Nov 22, 2024
81c49b5
Revert "removed duplicated code snippets"
gewarren Nov 22, 2024
7e34288
remove zone pivots
gewarren Nov 22, 2024
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
91 changes: 1 addition & 90 deletions docs/core/tutorials/cli-templates-create-template-package.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Create a template package for dotnet new
description: Learn how to create a csproj file that builds a template package for the dotnet new command.
author: adegeo
ms.date: 09/11/2023
zone_pivot_groups: dotnet-version
ms.topic: tutorial
ms.author: adegeo
---
Expand All @@ -16,27 +15,12 @@ You can view the completed template in the [.NET Samples GitHub repository](http

In this part of the series you'll learn how to:

::: zone pivot="dotnet-9-0,dotnet-8-0"

> [!div class="checklist"]
>
> * Create a template package by using the [Microsoft.TemplateEngine.Authoring.Templates](https://www.nuget.org/packages/Microsoft.TemplateEngine.Authoring.Templates) NuGet package.
> * Install a template package from a NuGet package file.
> * Uninstall a template package by package ID.

::: zone-end

::: zone pivot="dotnet-7-0,dotnet-6-0"

> [!div class="checklist"]
>
> * Create a \*.csproj project to build a template package.
> * Configure the project file for packing.
> * Install a template package from a NuGet package file.
> * Uninstall a template package by package ID.

::: zone-end

## Prerequisites

* Complete [part 1](cli-templates-create-item-template.md) and [part 2](cli-templates-create-project-template.md) of this tutorial series.
Expand All @@ -45,21 +29,11 @@ In this part of the series you'll learn how to:

* Open a terminal and navigate to the _working_ folder.

::: zone pivot="dotnet-8-0"

* Install .NET 8.
* Install .NET 8 or .NET 9.
* Install the `Microsoft.TemplateEngine.Authoring.Templates` template from the NuGet package feed.

* Run the `dotnet new install Microsoft.TemplateEngine.Authoring.Templates` command from your terminal.

::: zone-end

::: zone pivot="dotnet-7-0,dotnet-6-0"

[!INCLUDE [dotnet6-syntax-note](includes/dotnet6-syntax-note.md)]

::: zone-end

## Create a template package project

A template package is one or more templates packed into a NuGet package. When you install or uninstall a template package, all templates contained in the package are added or removed, respectively.
Expand All @@ -70,8 +44,6 @@ Normally you use a C# project file to compile code and produce a binary. However

The package you're going to generate will include the [item](cli-templates-create-item-template.md) and [project](cli-templates-create-project-template.md) templates previously created.

::: zone pivot="dotnet-8-0"

The [Microsoft.TemplateEngine.Authoring.Templates](https://www.nuget.org/packages/Microsoft.TemplateEngine.Authoring.Templates) package contains templates useful for template authoring. To install this package, nuget.org should be available as NuGet feed in the working directory.

01. In the _working_ folder, run the following command to create the template package:
Expand Down Expand Up @@ -116,63 +88,6 @@ The [Microsoft.TemplateEngine.Authoring.Templates](https://www.nuget.org/package
... cut for brevity ...
```

::: zone-end

::: zone pivot="dotnet-7-0,dotnet-6-0"

01. In the _working_ folder, run the following command to create the template package:

```dotnetcli
dotnet new console -n AdatumCorporation.Utility.Templates
```

The `-n` parameter sets the project file name to _AdatumCorporation.Utility.Templates.csproj_. You should see a result similar to the following output.

```output
The template "Console Application" was created successfully.

Processing post-creation actions...
Running 'dotnet restore' on .\AdatumCorporation.Utility.Templates.csproj...
Restore completed in 52.38 ms for C:\code\working\AdatumCorporation.Utility.Templates.csproj.

Restore succeeded.
```

01. Delete the _Program.cs_ file. The new project template generates this file but it's not used by the templates engine.

01. Next, open the _AdatumCorporation.Utility.Templates.csproj_ file in your favorite editor and replace the content with the following XML:

```xml
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<PackageId>AdatumCorporation.Utility.Templates</PackageId>
<PackageVersion>1.0</PackageVersion>
<Title>AdatumCorporation Templates</Title>
<Authors>Me</Authors>
<Description>Templates to use when creating an application for Adatum Corporation.</Description>
<PackageTags>dotnet-new;templates;adatum</PackageTags>
<PackageProjectUrl>https://your-url</PackageProjectUrl>

<PackageType>Template</PackageType>
<TargetFramework>netstandard2.0</TargetFramework>
<IncludeContentInPack>true</IncludeContentInPack>
<IncludeBuildOutput>false</IncludeBuildOutput>
<ContentTargetFolders>content</ContentTargetFolders>
<NoWarn>$(NoWarn);NU5128</NoWarn>
<NoDefaultExcludes>true</NoDefaultExcludes>
</PropertyGroup>

<ItemGroup>
<Content Include="content\**\*" Exclude="content\**\bin\**;content\**\obj\**" />
<Compile Remove="**\*" />
</ItemGroup>

</Project>
```

::: zone-end

### Description of the project XML

The settings under `<PropertyGroup>` in the XML snippet are broken into two groups.
Expand All @@ -193,8 +108,6 @@ In the second group, the `<TargetFramework>` setting ensures that MSBuild runs p
> [!TIP]
> For more information about NuGet metadata settings, see [Pack a template into a NuGet package (nupkg file)](../tools/custom-templates.md#pack-a-template-into-a-nuget-package-nupkg-file).

::: zone pivot="dotnet-8-0"

The created project file includes [template authoring MSBuild tasks](https://aka.ms/templating-authoring-tools) and localization settings.

```xml
Expand All @@ -212,8 +125,6 @@ The created project file includes [template authoring MSBuild tasks](https://aka

These MSBuild tasks provide template validation and [localization of the templates](https://aka.ms/templating-localization) capabilities. Localization is disabled by default. To enable creation of localization files, set `LocalizeTemplates` to `true`.

::: zone-end

## Pack and install

Save the project file. Before building the template package, verify that your folder structure is correct. Any template you want to pack should be placed in the _templates_ folder, in its own folder. The folder structure should look similar to the following hierarchy:
Expand Down
Loading
Loading