jcdcdev.Umbraco.PackageTemplate 0.2.0

There is a newer version of this package available.
See the version list below for details. 
dotnet new install jcdcdev.Umbraco.PackageTemplate::0.2.0
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 new jcdcdev-umb-package -o Demo.Package --gh-username jcdcdev --title "My Demo Package" --description "An empty Umbraco package" --author-name "James C" --author-description "Lead .NET Developer" --author-url "https://jcdc.dev" --author-image-url "https://github.com/jcdcdev.png"

  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

Name Description Example Value Required
--gh-username GitHub username - Used for project url and github actions. jcdcdev Yes
--title Package title - Used for NuGet metadata, README & umbraco-marketplace.json My Demo Package Yes
--description Package description - Used for NuGet metadata & umbraco-marketplace.json An empty Umbraco package Yes
--author-name Author name - Used for umbraco-marketplace.json James C Yes
--author-description Author description - Used for umbraco-marketplace.json Lead .NET Developer No
--author-url Author URL - Used for umbraco-marketplace.json https://jcdc.dev No
--author-image-url Author image URL - Used for umbraco-marketplace.json https://github.com/jcdcdev.png No
--package-type Package type - Used for umbraco-marketplace.json Package No
--category Package category - Used for umbraco-marketplace.json Developer Tools No
--add-client Add a Front End project using Lit.js and TypeScript. Configured for Umbraco UI. true No

Need help?

Contributing

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

Acknowledgments (thanks!)

  • net6.0

    • No dependencies.

  • net7.0

    • No dependencies.

  • 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 230 4/7/2024
0.2.1 153 3/26/2024
0.2.0 133 3/26/2024
0.1.2 904 2/18/2024
0.1.1 1,237 1/7/2024
0.1.0 137 1/7/2024