Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 3.92 KB

UsingTheTemplate.md

File metadata and controls

80 lines (52 loc) · 3.92 KB
Raw

Using the Template

Installing the template

dotnet new install Umbraco.Community.Templates.PackageStarter

Using the template

Warning

This is a first version of the template. At the moment please use it from the command line. If you use this from within Visual Studio to create a new solution you will end up with two solution files - a known issue!

Open a command prompt in a location where you want your new project repository folder to be created. For example, if you are in c:\source\ and use this template to create a project called 'MyNewProject' then the template will create the folder c:\source\MyNewProject\.

dotnet new umbracopackagestarter -n YourProjectName --authorName "Your Name" --githubUser "YourGitHubUsername" --githubRepo "YourGitHubRepoName"

Parameters:

  • -n : the name of your project. This will mean that:
    • The solution file will be: YourProjectName.sln
    • A project for the package will be in a folder: \YourProjectName
    • A test site for the package will be in a folder: \YourProjectName.TestSite
    • The nuget package id will be set as : Umbraco.Community.YourProjectName
  • -authorName : the display name of the author, e.g. "Lotte Pitcher"
  • -githubUser : the username of the GitHub user/organisation that will be hosting the repository
  • -githubRepo : the GitHub repository name for the project

Where do I put my files?

Put your files in the package project:

  • C# files can go in the root of the project folder, or in sub-folders: that's completely up to you!
  • Script and stylesheet files must be put somewhere under \wwwroot\YourProjectName\. Remember to add all your script and stylesheet files to the manifest filter (\YourProjectNameManifestFilter.cs)

Logo

TODO - where to put, and configure .csproj for nuget

Pushing to GitHub

TODO - create git repo locally, create completely empty GitHub repo (public/private), push to GH

Publishing to nuget / Umbraco Marketplace

Please note that the project has already been configured with the umbraco-marketplace tag. This means that the Marketplace will automatically find and index the package once it has been uploaded to nuget.

You can test how things should work/look before publishing as follows:

  • Test nuget package works by adding via local nuget command (TOD)

  • Check how nuget will 'see' your package by using nuget Package Explorer (LINK?)
  • Validate Marketplace configuration from https://marketplace.umbraco.com/validate and the JSON option

Happy? If so, let's get this published!

Warning

Please make sure you are happy with the nuget package id before you continue. Titles, descriptions can all be changed, but you can't change the id of a nuget package once created, you can only deprecate it and start a new one.

  1. Update the version number
    1. Open src/YourProjectName/YourProjectName.csproj
    2. Change the <Version>...</Version> - I use Semantic Versioning
  2. Add corresponding tag in Git
  3. Push to GitHub - a GitHub action should then release the new version to nuget
  4. Create a release on GitHub:
    1. On the home page of your repo in GitHub click the 'X tags' link
    2. Your new version should be listed: click the three dots and 'Create Release'

Improve your package on the Marketplace

There is more information that you can add to the umbraco-marketplace.json file in the root of your repository to improve how the package appears on the marketplace.

Check the instructions on the Marketplace for more information.

Once you've updated the .json file and pushed to GitHub, the Marketplace should reindex and update the package details soon. If things don't look as you expect, use the validation tool.

If you don't want to wait... check instructions for forcing marketplace to update immediately for your package.

Publishing updates

Is exactly the same 4 step process as you followed when you first released.