jcdcdev.Umbraco.PackageTemplate

An opinionated template for creating Umbraco packages hosted on GitHub.

Quick Start

Prerequisites

1. A basic understanding of NuGet package development

   • A NuGet API key - Create an API key

2. A git repository on GitHub

   • Your repository name must match the project name e.g. Demo.Package
   • GitHub Action Secret - NUGET_API_KEY with your NuGet API key

3. Install template

   dotnet new install jcdcdev.Umbraco.PackageTemplate

Create package

1. Create new project

   dotnet CLI

   dotnet new jcdcdev-umb-package -o Demo.Package --ghUsername jcdcdev --title "My Demo Package" --description "An empty Umbraco package" --addClient    

   Visual Studio

   • Open Visual Studio
   • Create a new project
   • Search for jcdcdev-umb-package
   • Click Next
   • Fill in the project title, description, and other details
   • Click Create

2. Open project in your IDE

3. Build and run project

4. Congratulations! You have created an empty Umbraco package 🎉

Now you can implement your package features.

1. Update README.md with your package details
2. Update umbraco-marketplace.json with your package details

Publish

1. Push your code to GitHub
2. Create a pull request into the main branch
3. Merge the pull request
4. A new release will be created

Configuration

Template Parameters

Documentation

Contributing

Contributions to this package are most welcome! Please visit the Contributing page.