Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 2.58 KB

BUILD.md

File metadata and controls

37 lines (28 loc) · 2.58 KB

Building Dnn

You do not always need to build the entire solution, you can download and install from the releases and only build the part you are working on, please read How to Contribue first.

If you do need to build the entire solution and the distribution packages, you need to be aware that the entire distribution is split in multiple github repositories.

  • This repository - contains all the core APIs and the Admin Experience (Persona Bar)
  • CKEditorProvider - The default HTML Editor Provider
  • CDF - The Dnn Client Dependency Framework

Also, we currently maintain two branches, the development branch is the next major release and we also maintain a release/x.x.x branch that allows doing bug fixes on the current major version.

To prevent issues with long paths in some build scripts, fork this repository in a short named folder on the root of any drive such as c:\dnnsrc\ if you fork to a long path such as c:\users\username\documents\dnn\source\ you may encounter long path issues.

In order to build the whole solution and produce the install and upgrade packages, you simply need to open PowerShell and run the following command:

.\build.ps1

The version you are building is the current version on the branch you are. However there are 2 external repositories that get bundled into Dnn build: Dnn.Connect CKEditor provider is the default HTML editor provider and its default branch is development. Dnn.ClientDependency, the default branch is dnn Under normal situations they are the branches used for the next release, however if you have a need to specify a different branch to pull during the build you can specify them as such:

.\build.ps1 -ScriptArgs '--CkBranch="branch-name"','--CdfBranch="branch-name"'

If you encounter any build issues, please re-run the build with more verbosity as such:

.\build.ps1 -Verbosity diagnostic

This will log much more information about the problem and allow you to open an issue with those more detailed logs.

Also, the build scripts should leave you with 0 tracked modified files in git. If a build fails midway and you have tracked artifacts, you can simply run: git reset --hard and/or git clean -dxf in order to come back to a clean state.

If you encounter PowerShell security issues, please read Cake - PowerShell Security