Use this dotnet new template to get a head start for creating, releasing and maintaining Umbraco Packages for v10+.
I've called it an 'opinionated' package starter template because lots of decisions have been made for you. This means that all you really have to worry about is adding your package code. A lot of the other stuff involved in releasing a package and having a well-maintained open source GitHub repository has been done already.
Of course none of these decisions are irreversible. Once you've used the template you can change whatever you need to. Please make sure you read this readme so you understand what choices you are starting with so that you can change them where necessary before you push to GitHub, and definitely before you publish to nuget!
Nothing! You can find a link to it here. It's just that all it gives you is the actual package project. You'll need to work out how you're going to test your package, how to configure it for nuget, how you're going to release to nuget, add certain files for a well maintained repo ...
Whereas this template will create a folder with:
- A new solution (.sln)
- A package project ready for you to add your code. There's a lang .xml file in the right place to remind you to use those where feasible (instead of hard-coding text in your views)
- A test site referencing the package project
- A GitHub action for publishing to nuget
- A good start on:
- The readme for your GitHub repository
- The readme for your nuget package
- The
umbraco-marketplace.jsonfile which improves how your package appears on the Umbraco Marketplace
- GitHub templates to help people create good issues and feature requests
- And more!
- License: MIT
- Umbraco version: v10.0.0
- nuget package Id:
Umbraco.Community.YourPackageName - 'App_Plugins' or Razor Class Library: RCL
- Initial version number: 0.1.0
Because Umbraco CMS is released with an MIT license, and I've assumed you're releasing this as an open source package too.
Because it's the current Long Term Support release. I believe plenty of sites will be staying on v10 for a while ... If there is a need to restrict your package to a version of 10 higher than 10.0.0 then you should raise the dependency in your package. Refer to issue 10 for a discussion about this.
If you don't have a company or personal brand to use as a prefix, then this is a well used convention for Umbraco community projects.
Because RCLs mean that your package assets are added virtually to your project: you don't need a targets file in your test site to physically copy the App_Plugins contents over. It also makes it easier for people who install your package as they don't have to commit your App_Plugins folder to their project repository.
If you want to understand more about RCLs, and what is involved in converting a package to be a Razor Class Library, please refer to PR 8.
The project is created with version 0.1.0 as this fits the SemVer scheme. The version number is set in the .csproj of the package project.
Please read the instructions for how to install the template and use it.
Yes feedback, thoughts, issues, pull requests... are of course most welcome!
Please read the Contributing Guidelines.
A lot of the decisions were made whilst collaborating with Lee Kelleher (the creator of Contentment and many other Umbraco packages) whilst developing my Admin Only Property package. So big #H5YR for all your help Lee 🙏!
"out of the box" by Yoyon Pujiyono from Noun Project