-
-
Notifications
You must be signed in to change notification settings - Fork 494
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a new Nuget Package Project Template (#503)
* Add NuGet Package Template * Add preview image and link to main README * Rename from ReadMe.html to TODO.html * Allow NuGet package signing on Ubuntu and MacOS * Update .editorconfig file * Use dotnet tool manifest file for Cake.Tool
- Loading branch information
1 parent
bb6039f
commit c348970
Showing
49 changed files
with
2,256 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,22 +29,21 @@ jobs: | |
uses: actions/setup-dotnet@v1 | ||
with: | ||
dotnet-version: 3.1.101 | ||
- name: 'Dotnet Tool Restore' | ||
run: dotnet tool restore | ||
shell: pwsh | ||
- name: 'Dotnet Cake Build' | ||
uses: ecampidoglio/[email protected] | ||
with: | ||
target: Build | ||
run: dotnet cake --target=Build | ||
shell: pwsh | ||
- name: 'Dotnet Cake InstallDeveloperCertificate' | ||
uses: ecampidoglio/[email protected] | ||
with: | ||
target: InstallDeveloperCertificate | ||
run: dotnet cake --target=InstallDeveloperCertificate | ||
shell: pwsh | ||
- name: 'Dotnet Cake Test' | ||
uses: ecampidoglio/[email protected] | ||
with: | ||
target: Test | ||
run: dotnet cake --target=Test | ||
shell: pwsh | ||
- name: 'Dotnet Cake Pack' | ||
uses: ecampidoglio/[email protected] | ||
with: | ||
target: Pack | ||
run: dotnet cake --target=Pack | ||
shell: pwsh | ||
- name: 'Publish Artefacts' | ||
uses: actions/[email protected] | ||
with: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
![.NET Boxed Banner](https://media.githubusercontent.com/media/Dotnet-Boxed/Templates/master/Images/Banner.png) | ||
|
||
![NuGet Package Boxed Preview Image](https://media.githubusercontent.com/media/Dotnet-Boxed/Templates/master/Images/Orleans-Preview.png) | ||
|
||
## Optional Feature Selection | ||
|
||
The NuGet package project template uses `dotnet new` to enable you to turn features of the project template on or off. Find out more about `dotnet new` [here](http://rehansaeed.com/custom-project-templates-using-dotnet-new/). | ||
|
||
#### Project | ||
|
||
- **Title** - The name of the project which determines the assembly product name. | ||
- **Description** - A description of the project which determines the assembly description. | ||
- **Author** - The name of the author of the project which determines the assembly author and copyright information. | ||
- **Tags** - A semi-colon `;` delimited list of tags for the NuGet package. | ||
- **Contact** - The contact details to use if someone wants to contact you about a security vulnerability or code of conduct issues. | ||
- **DotnetCore** - Sets .NET Core as one of the target frameworks. | ||
- **DotnetFramework** - Sets .NET Framework as one of the target frameworks. | ||
- **ReadMe** - Add a README.md markdown file describing the project. | ||
- **EditorConfig** - Add a .editorconfig file to set a fixed code style. | ||
- **License** - The legal license applied to the source code in this project. | ||
- **MIT** - The MIT license. | ||
- **None** - No license, the source code cannot be legally shared. | ||
- **TreatWarningsAsErrors** - Treat warnings as errors. | ||
- **StyleCop** - Adds and enforces StyleCop analysers. | ||
- **Tests** - Adds a unit test project. | ||
|
||
#### Source Control | ||
|
||
- **Git** - Add a .gitignore file to stop Git from checking in temporary files and a .gitattributes to use git LFS. | ||
- **SourceControl** - Select which source control provider you are using if any, to add provider specific features. | ||
- **GitHub** - Adds .github directory containing a code of conduct, contributing guide, pull request template and issue templates. | ||
- **None** - No source control provider is being used. | ||
- **GitHubUsername** - Your GitHub username or organisation name that the project lives under. | ||
- **GitHubProject** - The name of your GitHub project. | ||
|
||
#### Continuous Integration (CI) | ||
|
||
- **AppVeyor** - Adds AppVeyor continuation integration build file appveyor.yml. | ||
- **AzurePipelines** - Adds Azure Pipelines continuation integration build file azure-pipelines.yml. | ||
- **GitHubActions** - Adds GitHub Actions continuation integration build file .github/workflow/build.yml. | ||
|
||
## Always On Features | ||
|
||
- **Signing** - The package is signed. However, you should change the .pfx file. | ||
- **SourceLink** - During debugging, you can step into code from your NuGet package using [Source Link](https://docs.microsoft.com/en-us/dotnet/standard/library-guidance/sourcelink). | ||
|
||
## How can I get it? | ||
|
||
1. Install the latest [.NET Core SDK](https://dot.net). | ||
2. Run `dotnet new --install Boxed.Templates` to install the project template. | ||
3. Run `dotnet new nuget --help` to see how to select the feature of the project. | ||
5. Run `dotnet new nuget --name "MyProject"` along with any other custom options to create a project from the template. | ||
|
||
## Release Notes and To-Do List | ||
You can find release notes for each version [here](https://github.com/Dotnet-Boxed/Templates/releases) and a To-Do list of new features and enhancements coming soon in the [projects](https://github.com/Dotnet-Boxed/Templates/projects) tab. | ||
|
||
## Contributing | ||
|
||
Please view the [Contributing](/.github/CONTRIBUTING.md) guide for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
Oops, something went wrong.