Skip to content

Commit 481c5b9

Browse files
author
Сергей Трегуб
committed
Update template's details
1 parent dc4683e commit 481c5b9

7 files changed

Lines changed: 97 additions & 83 deletions

File tree

ProjectTemplates/DrWatson1.ProjectTemplate.RestAPI.csproj

Lines changed: 50 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,65 @@
22

33
<PropertyGroup>
44
<PackageType>Template</PackageType>
5-
<PackageVersion>2.6</PackageVersion>
5+
<PackageVersion>3.0</PackageVersion>
66
<PackageId>DrWatson1.ProjectTemplate.RestAPI</PackageId>
7-
<Title>ASP.Net Core RESTful Service Template</Title>
7+
<Title>ASP.Net REST API Service Template</Title>
88
<Authors>Sergey Tregub</Authors>
9-
<Description>Project template to create production-ready RESTful service based on ASP.Net Core v3.1 or 5.0. It contains preconfigured DI-container, logging, CORS, some boilerplate code and other features</Description>
9+
<Description>Project template to create production-ready RESTful service based on ASP.Net 6. It contains preconfigured DI-container, logging, CORS, some boilerplate code and other features</Description>
1010
<PackageTags>dotnet-new;templates;webapi;web;rest-api</PackageTags>
1111
<TargetFramework>netcoreapp3.1</TargetFramework>
1212

1313
<IncludeContentInPack>true</IncludeContentInPack>
1414
<IncludeBuildOutput>false</IncludeBuildOutput>
1515
<ContentTargetFolders>content</ContentTargetFolders>
1616
<NoWarn>$(NoWarn);NU5128</NoWarn>
17-
<PackageReleaseNotes>Support of .Net Core 5.0 and dotnet new custom template</PackageReleaseNotes>
17+
<PackageReleaseNotes>3.0 - 2022-06-13
18+
- BREAKING CHANGES: Drop support of .Net Core 3.1
19+
- The template now uses .Net 6.0 by default
20+
- Support of Visual Studio 2022
21+
- All packages was updated to the latest versions
22+
23+
2.6 - 2021-05-03
24+
- Support of .Net 5.0
25+
- Add `dotnet new` custom template
26+
27+
2.5 - 2021-03-07
28+
- Minor fixes
29+
30+
2.4 - 2021-02-27
31+
- Improve logging
32+
33+
2.3 - 2021-02-23
34+
- Load .env before Serilog initialization to make it possible to use environment variables in Serilog configuration options
35+
- Catch and log unhandled exceptions
36+
- Update NuGet packages to the latest versions
37+
38+
2.2 - 2020-08-14
39+
- Allow Swagger to work behind a proxy
40+
- Improve Application Settings with `Options Pattern` and [Configuration Extensions](https://github.com/drwatson1/configuration-extensions)
41+
- Update NuGet packages to the latest versions
42+
43+
2.1 - 2020-01-22
44+
- Fix deploying to IIS
45+
- Fix publishing the service
46+
47+
2.0 - 2020-01-22
48+
- Change target framework to .Net Core 3.1
49+
- Add health check service
50+
51+
1.3 - 2020-01-21
52+
- Update target framework to .Net Core 2.2
53+
54+
1.2 - 2019-08-22
55+
- Project tags are added to make it simple to find this project template in a VS2019 project creation wizard
56+
- Update NuGet packages to the latest versions
57+
58+
1.1 - 2019-04-03
59+
- Support VS2019
60+
61+
1.0 - 2019-01-21
62+
- Initial version
63+
</PackageReleaseNotes>
1864
<PackageLicenseFile>LICENSE</PackageLicenseFile>
1965
<PackageProjectUrl>https://github.com/drwatson1/AspNet-Core-REST-Service</PackageProjectUrl>
2066
<RepositoryUrl>https://github.com/drwatson1/AspNet-Core-REST-Service</RepositoryUrl>

ProjectTemplates/How to create a new template.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ After making any changes do:
66
1. Select Release configuration for a solution
77
1. Select ReferenceProject in "Solution Explorer" and click "Project/Export Template..." menu item from the VS main menu
88
1. In the appeared dialog box select "Project template" option and "ReferenceProject" in the combobox below and click Next
9-
1. Set the value `ASP.Net Core RESTful Service` as a template name and the `Project template to create production-ready RESTful service based on ASP.Net Core v3.1 or 5.0. It contains preconfigured DI-container, logging, CORS, some boilerplate code and other features` as a description
9+
1. Set the value `ASP.Net REST API` as a template name and the `Project template to create production-ready RESTful service based on .Net 6. It contains preconfigured DI-container, logging, CORS, some boilerplate code and other features` as a description
1010
1. Don't foget to replace .Net Core version in the description above to the appropriate one.
1111
1. Clear checkbox "Automatically import the template into Visual Studio" if you don't want immediately import it and click Finish button
12-
1. Extract all files from the created zip-archive to any folder as you want. Typically, the file can be found in `C:\Users\<YOU>\Documents\Visual Studio 2019\My Exported Templates` folder
12+
1. Extract all files from the created zip-archive to any folder as you want. Typically, the file can be found in `C:\Users\<YOU>\Documents\Visual Studio 2022\My Exported Templates` folder
1313
1. Open a file "MyTemplate.vstemplate"
1414
1. Replace content of the tag `DefaultName` in the section `TemplateData` to `ASPNetCore.Service`
1515
1. Add the following tags to the same section:
@@ -18,16 +18,17 @@ After making any changes do:
1818
<LanguageTag>C#</LanguageTag>
1919
<PlatformTag>windows</PlatformTag>
2020
<PlatformTag>linux</PlatformTag>
21-
<ProjectTypeTag>web</ProjectTypeTag>
21+
<ProjectTypeTag>WebApi</ProjectTypeTag>
22+
<ProjectTypeTag>REST API</ProjectTypeTag>
2223
<ProjectTypeTag>RESTful Service</ProjectTypeTag>
2324
```
24-
1. Add all files from the folder to zip-archive with a name `ASP.Net Core RESTful Service.zip`. All added files must be in the root of the archive
25+
1. Add all files from the folder to zip-archive with a name `ASP.Net REST API.zip`. All added files must be in the root of the archive
2526
1. Copy this file to `ProjectTemplates\ReferenceProjectVSIX\ProjectTemplates\CSharp\.NET Core` folder and replace an existing one
2627
1. Go to VS, expand a ReferenceProjectVSIX project and double click on source.extension.vsixmanifest file
2728
1. Increase minor version number on the tab "Metadata" in the top right corner
2829
1. Update template description
29-
1. Add Release Notes
30-
1. Rebuild the ReferenceProjectVSIX project and get "ASP.Net Core RESTful Service Template.vsix"
30+
1. Update ReleaseNotes.txt
31+
1. Rebuild the ReferenceProjectVSIX project and get "ASP.Net REST API Service Template.vsix"
3132

3233
**Create a .Net Core Custom template**
3334
1. Open the `DrWatson1.ProjectTemplate.RestAPI.csproj`
Binary file not shown.

ProjectTemplates/ReferenceProjectVSIX/ReferenceProjectVSIX.csproj

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<OutputType>Library</OutputType>
1515
<AppDesignerFolder>Properties</AppDesignerFolder>
1616
<RootNamespace>ReferenceProjectVSIX</RootNamespace>
17-
<AssemblyName>ASP.Net Core RESTful Service Template</AssemblyName>
17+
<AssemblyName>ASP.Net REST API Service Template</AssemblyName>
1818
<TargetFrameworkVersion>v4.7.1</TargetFrameworkVersion>
1919
<GeneratePkgDefFile>false</GeneratePkgDefFile>
2020
<IncludeAssemblyInVSIXContainer>false</IncludeAssemblyInVSIXContainer>
@@ -43,7 +43,7 @@
4343
<DefineConstants>TRACE</DefineConstants>
4444
<ErrorReport>prompt</ErrorReport>
4545
<WarningLevel>4</WarningLevel>
46-
<DeployExtension>False</DeployExtension>
46+
<DeployExtension>True</DeployExtension>
4747
</PropertyGroup>
4848
<ItemGroup>
4949
<Compile Include="Properties\AssemblyInfo.cs" />
@@ -58,7 +58,7 @@
5858
<IncludeInVSIX>true</IncludeInVSIX>
5959
</Content>
6060
<None Include="Assets\logo.xcf" />
61-
<Content Include="ProjectTemplates\CSharp\.NET Core\ASP.Net Core RESTful Service.zip">
61+
<Content Include="ProjectTemplates\ASP.Net REST API.zip">
6262
<CopyToOutputDirectory>Always</CopyToOutputDirectory>
6363
<IncludeInVSIX>true</IncludeInVSIX>
6464
</Content>
Lines changed: 35 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,46 @@
1-
3.0
2-
2022-06-13
1+
3.0 - 2022-06-13
2+
- BREAKING CHANGES: Drop support of .Net Core 3.1
3+
- The template now uses .Net 6.0 by default
4+
- Support of Visual Studio 2022
5+
- All packages was updated to the latest versions
36

4-
- BREAKING CHANGES: Drop support of .Net Core 3.1
5-
- The template now uses .Net 6.0 by default
6-
- Support of Visual Studio 2022
7-
- All packages was updated to the latest versions
7+
2.6 - 2021-05-03
8+
- Support of .Net 5.0
9+
- Add `dotnet new` custom template
810

11+
2.5 - 2021-03-07
12+
- Minor fixes
913

10-
2.6
11-
2021-05-03
14+
2.4 - 2021-02-27
15+
- Improve logging
1216

13-
- Support of .Net 5.0
14-
- Add `dotnet new` custom template
17+
2.3 - 2021-02-23
18+
- Load .env before Serilog initialization to make it possible to use environment variables in Serilog configuration options
19+
- Catch and log unhandled exceptions
20+
- Update NuGet packages to the latest versions
1521

22+
2.2 - 2020-08-14
23+
- Allow Swagger to work behind a proxy
24+
- Improve Application Settings with `Options Pattern` and [Configuration Extensions](https://github.com/drwatson1/configuration-extensions)
25+
- Update NuGet packages to the latest versions
1626

17-
2.5
18-
2021-03-07
19-
- Minor fixes
27+
2.1 - 2020-01-22
28+
- Fix deploying to IIS
29+
- Fix publishing the service
2030

31+
2.0 - 2020-01-22
32+
- Change target framework to .Net Core 3.1
33+
- Add health check service
2134

22-
2.4
23-
2021-02-27
24-
- Improve logging
35+
1.3 - 2020-01-21
36+
- Update target framework to .Net Core 2.2
2537

38+
1.2 - 2019-08-22
39+
- Project tags are added to make it simple to find this project template in a VS2019 project creation wizard
40+
- Update NuGet packages to the latest versions
2641

27-
2.3
28-
2021-02-23
42+
1.1 - 2019-04-03
43+
- Support VS2019
2944

30-
- Load .env before Serilog initialization to make it possible to use environment variables in Serilog configuration options
31-
- Catch and log unhandled exceptions
32-
- Update NuGet packages to the latest versions
33-
34-
35-
2.2
36-
2020-08-14
37-
38-
- Allow Swagger to work behind a proxy
39-
- Improve Application Settings with `Options Pattern` and [Configuration Extensions](https://github.com/drwatson1/configuration-extensions)
40-
- Update NuGet packages to the latest versions
41-
42-
43-
2.1
44-
2020-01-22
45-
46-
- Fix deploying to IIS
47-
- Fix publishing the service
48-
49-
50-
2.0
51-
2020-01-22
52-
53-
- Change target framework to .Net Core 3.1
54-
- Add health check service
55-
56-
57-
1.3
58-
2020-01-21
59-
60-
- Update target framework to .Net Core 2.2
61-
62-
63-
1.2
64-
2019-08-22
65-
66-
- Project tags are added to make it simple to find this project template in a VS2019 project creation wizard
67-
- Update NuGet packages to the latest versions
68-
69-
70-
1.1
71-
2019-04-03
72-
73-
- Support VS2019
74-
75-
76-
1.0
77-
2019-01-21
78-
79-
- Initial version
45+
1.0 - 2019-01-21
46+
- Initial version

ProjectTemplates/ReferenceProjectVSIX/source.extension.vsixmanifest

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
33
<Metadata>
44
<Identity Id="ASP.Net Core RESTful Service Template-1" Version="3.0" Language="en-US" Publisher="Sergey Tregub" />
5-
<DisplayName>.Net 6 RESTful Service Template</DisplayName>
5+
<DisplayName>ASP.Net REST API Service Template</DisplayName>
66
<Description xml:space="preserve">Project template to create production-ready RESTful service based on ASP.Net 5.0 or 6.0. It contains preconfigured DI-container, logging, CORS, some boilerplate code and other features</Description>
77
<MoreInfo>https://github.com/drwatson1/AspNet-Core-REST-Service</MoreInfo>
88
<GettingStartedGuide>https://github.com/drwatson1/AspNet-Core-REST-Service/wiki</GettingStartedGuide>
@@ -21,7 +21,7 @@
2121
<Dependencies>
2222
</Dependencies>
2323
<Assets>
24-
<Asset Type="Microsoft.VisualStudio.ProjectTemplate" d:Source="File" Path="ProjectTemplates" d:TargetPath="ProjectTemplates\CSharp\.NET Core\ASP.Net Core RESTful Service.zip" />
24+
<Asset Type="Microsoft.VisualStudio.ProjectTemplate" d:Source="File" Path="ProjectTemplates" d:TargetPath="ProjectTemplates\ASP.Net REST API.zip" />
2525
</Assets>
2626
<Prerequisites>
2727
<Prerequisite Id="Microsoft.VisualStudio.Component.CoreEditor" Version="[15.0,)" DisplayName="Visual Studio core editor" />

0 commit comments

Comments
 (0)