A template repository meant to be used for solutions intended to be published to nuget.
./
|-- .github/
|-- workflows/
|-- src/
|-- RenameMe.sln
|-- tests/
Don't forget to rename the solution file before creating projects
Git version is supported out of the box with a relatively simple configuration which can be found in the GitVersion file.
The .git ignore file is tailored for dotnet projects and includs ignores for
.idea/ (JetBrains) and .DS_Store/ (OSx) folders. Depending on the use case
the .gitignore file may need to be updated.
A license file for MIT is included. The default copyright is for
Oneirosoft and can be updated as needed.
Check the date as it may need to be updated accordinly.
Included are workflows for:
- ci
- ci-pr
- publish
These templates are located in .github/workflows.
ci
The ci workflow will build and test all projects in the solution when
an update to main or a tag starting with v* is pushed or merged.
The tests use MSTest Adaptor and will need to be modified when using Microsoft's Testing Platform.
ci-pr
The ci-pr workflow will build and run for any pull request.
The tests use MSTest Adaptor and will need to be modified when using Microsoft's Testing Platform.
publish
Publish will publish all packable projects contained in the soltuion and relies
on a NUGET_API_KEY to be present for the workflow. All projects will be built
and tested before being packed and published to nuget.org.
The tests use MSTest Adaptor and will need to be modified when using Microsoft's Testing Platform.
A sample unit test project has been included and should be renamed appropriately.
The unit tests should be placed in src/tests/.
The placeholder.txt file can be safely removed and is only
there for git