# Changes between Version 21 and Version 22 of Documentation/DevelopmentCenter/CreateNewPluginUsingVS

Ignore:
Timestamp:
07/25/14 13:25:47 (8 years ago)
Comment:

Unmodified
Removed
Modified
• ## Documentation/DevelopmentCenter/CreateNewPluginUsingVS

 v21 [[PageOutline]] = Quick guide: Create a new plugin using Visual Studio = We assume that you have obtained the source as described in [[Documentation/DevelopmentCenter/DownloadAndBuildSource|Quick guide: Download and build sources]]. We assume your directory structure looks as follows: == For HL core developers == HL core developers must check out the trunk, branches and stable folders, though not all of the individual branches need to be checked out. //New functionality should be developed in a branch and not in the trunk. The merge back into the trunk will occur, after a new feature reaches maturity. This requires at least a code review and clearance by head developer Stefan Wagner!// * SVN repository main: [[https://svn.heuristiclab.com/svn/core]] (use "Choose Items" in the checkout dialog to limit the depth of the branches) If you develop new projects, they must reside inside a directory that denotes major.minor version. If a plugin is named HeuristicLab.Problems.Mine, the project files should be placed inside HeuristicLab.Problems.Mine\3.3\HeuristicLab.Problems.Mine-3.3.csproj. Note that the version number is also appended to the .csproj file. === Configuring the project properties === Once a project has been created and the directory structure has been adapted, the project properties need to be adjusted. * The output name of the project should include the version number, e.g. HeuristicLab.Problems.Mine-3.3 * The default namespace should be free from version numberings, e.g. HeuristicLab.Problems.Mine * The target framework needs to be set to .NET Framework 4.0 (not the client profile!). * On the build tab please choose the appropriate output path. In case a branch is merged into the trunk this should be changed as well! * ..\..\bin for projects inside the trunk * ..\..\..\..\trunk\sources\bin\ for projects inside the branches directory * We typically use pre-build events for automatic versioning. This expects a Plugin.cs.frame and Properties\AssemblyInfo.cs.frame file to be present in your project (see below). It will replace the version placeholder with the SVN version and overwrite the respective .cs file. Note that you must at least add your code in the working copy for this to work. Typically, these are the pre-build commands: {{{ set Path=%Path%;$(ProjectDir);$(SolutionDir) set ProjectDir=$(ProjectDir) set SolutionDir=$(SolutionDir) set Outdir=$(Outdir) call PreBuildEvent.cmd }}} * If you are on a branch, copy the PreBuildEvent.cmd to your branch directory === Adding references to a project === If you are working within the HeuristicLab solution, you can reference other projects through ''project references''. If you are working in your own solution, reference the assemblies in {{{trunk\sources\bin\}}}. In both cases, if you add references, '''switch the "Copy local" option to false''' in the properties of the reference. Otherwise your build might break! === Use the configuration manager === Create configurations for debug and release builds and all platforms (Any CPU, x86, x64). Make sure that the respective solution configurations target the right configuration of your projects and that they are checked. === Create frame files === Each HeuristicLab plugin has two frame template files, AssemblyInfo.cs.frame and Plugin.cs.frame. We use these .frame files and SubWCRev to automatically convert those into .cs files and add the repository version number to the revision-version. * AssemblyInfo.cs.frame * AssemblyVersion --> if this one changes all dependent plugins must be rebuilt as well, should be set to e.g. 3.3.0.0 and touched only again when major or minor version changes * AssemblyFileVersion --> not relevant for build process, should be set to e.g. 3.3.10.$WCREV$* Plugin.cs.frame * Used to replace your plugin version number with the build number on SVN commit, e.g. 3.3.10.$WCREV$* If you check in your sources make sure to exclude and ignore AssemblyInfo.cs and Plugin.cs on commit === Configuring the plugin file === * Plugin attribute [Plugin("HeuristicLab.Problems.Mine", "3.3.0.$WCREV\$")] * PluginDependencies --> Please make sure that you list all referenced plugins. There is a unit test that checks if you have included all or if you have specified too many * Version numbers: Major and minor must be set for all plugins, e.g. 3.3 or 3.4 === Trunk integration === When your branch has matured and is ready for trunk integration, you should remove your branch and add your projects to the trunk solution. * Remember that the output path for trunk projects is different, change it! * Convert all references to project references (don't forget to set Copy Local to false!) * Add your project to the build dependencies of the HeuristicLab-3.3 project to ensure that your project is also built on every rebuild. To do this right click on the solution, Properties, Project Dependencies, select the HeuristicLab-3.3 project. * Add your plugin as a reference to the HeuristicLab.Tests project * Sign the project with the HeuristicLab key (if you haven't done so already) * Check all source files and Designer generated source files for a GPL license header * If you want to add a custom resource (say, an image), it belongs into HeuristicLab.Common.Resources. Mail Stefan Wagner if you require custom resources. Note that the image should have a license that is compatible with the GPL.