jcdcdev.Umbraco.PackageTemplate 0.2.2 

dotnet new install jcdcdev.Umbraco.PackageTemplate::0.2.2
This package contains a .NET Template Package you can call from the shell/command line.

jcdcdev.Umbraco.PackageTemplate

Umbraco Version NuGet GitHub license Downloads

An opinionated template for creating Umbraco packages hosted on Github.

Quick Start

Prerequisites

  1. A basic understanding of NuGet package development

  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

Template Parameters

Long Name Short Name Description Datatype Default Value Required
ghUsername u GitHub Username - Used for generating Package, Author, Documentation & Issues URLs string Yes
title t Package Title - Used for generating NuGet package title string Yes
description d Package Description - Used for generating NuGet package description and README.md string Yes
authorName an Package Author - Used for generating NuGet Author and Copyright string No
authorDescription ad Package Author Description - Used for umbraco-marketplace.json string No
authorUrl au Package Author URL - Used for umbraco-marketplace.json string https://github.com/ghUsername No
authorImageUrl aiu Package Author Image URL - Used for umbraco-marketplace.json string https://github.com/ghUsername.png No
packageType pt Package Type - Used for umbraco-marketplace.json choice Package No
category c Package Category - Used for umbraco-marketplace.json choice Developer Tools No
addClient ac Includes a client project for the package (Lit.js & TypeScript) bool false No

Test Sites

The solution includes a test site for testing your package features against the following Umbraco versions:

  • 10.4.0
  • 12.0.0
  • 13.0.0

Your package project is automatically referenced in each test site.

Running Locally

On first boot each test site will:

  • Create a SQLite database
  • Create an admin user
    • Username: admin@example.com
    • Password: 1234567890
  • Run a uSync import to add starter content

Need help?

Contributing

Contributions to this package are most welcome! Please read the Contributing Guidelines.

Acknowledgments (thanks!)

  • net8.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.2.2 226 4/7/2024
0.2.1 152 3/26/2024
0.2.0 132 3/26/2024
0.1.2 902 2/18/2024
0.1.1 1,236 1/7/2024
0.1.0 136 1/7/2024