Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplifies local build command #3092

Merged
merged 5 commits into from
Oct 5, 2019
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions .github/BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,27 @@ Also, we currently maintain two branches, the development branch is the next maj

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.

If you need to build the next major release you simply need to open PowerShell and run the following command:
To build the whole project and create the install/upgrade packages simply open powershell and run:
```
.\build.ps1 -Target BuildAll
.\build.ps1
```

But if you need to build from one of the release branches, then you also need to reference each branch you want to pull from those repositories as such (example for the 9.4.0 release, replace the branch names as needed):
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](https://github.com/DNN-Connect/CKEditorProvider) is the default HTML editor provider and its default branch is development.
[Dnn.ClientDependency](https://github.com/dnnsoftware/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 -Target BuildAll -ScriptArgs '--CkBranch="development"','--CdfBranch="dnn"','--CpBranch="release/3.0.x"'
.\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 -Target BuildAll -Verbosity diagnostic
.\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.

If you encounter PowerShell security issues, please read [Cake - PowerShell Security](https://cakebuild.net/docs/tutorials/powershell-security)
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](https://cakebuild.net/docs/tutorials/powershell-security)
2 changes: 1 addition & 1 deletion build.cake
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ Task("Run-Unit-Tests")
//////////////////////////////////////////////////////////////////////

Task("Default")
.IsDependentOn("Build");
.IsDependentOn("BuildAll");

//////////////////////////////////////////////////////////////////////
// EXECUTION
Expand Down