This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
map_suite_via_nuget [2017/03/21 14:55] jd Changed to include more information |
map_suite_via_nuget [2017/03/30 14:59] (current) benbai |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Map Suite via NuGet ====== | ====== Map Suite via NuGet ====== | ||
- | In Map Suite 10.0 we ar starting to provide our products via packages on NuGet. This will allow references to our products to be added and updated easily. We have three different types of packages on NuGet, feature packages, dependancy packages, and product packages, which will be expained in detail below. Each of these packages will also have two different build branches, production and development. | + | In Map Suite 10.0 we have started to provide our products via packages on NuGet. This will allow references to our products to be added and updated easily. We have three different types of packages on NuGet: feature packages, dependency packages, and product packages. These will be explained in detail below. Each of these packages will also have two different build branches: production and development. |
===== Map Suite NuGet Packages ===== | ===== Map Suite NuGet Packages ===== | ||
- | We have three different types of packages, feature packages, dependancy packages, and product packages. You can tell the difference between these packages by their name. Feature Packages begin with "ThinkGeo.MapSuite" and are named for the namespace and class that they contain. Dependancy Packages begin with "MapSuiteDependency" and contain repackaged 3rd party dependancies. Product packages are named for what product they support and their name ends with either Standard or Barebones. | + | We have three different types of packages: feature packages, dependency packages, and product packages. You can tell the difference between these packages by their name. Feature Packages begin with "ThinkGeo.MapSuite" and are named for the namespace and class that they contain. Dependency Packages begin with "MapSuiteDependency" and contain repackaged third party dependencies. Product packages are named for what product they support and their name ends with either Standard or Barebone. |
==== Feature Packages ==== | ==== Feature Packages ==== | ||
- | Feature packages contain one specific feature, such as a data source, and can be added or removed from your product as needed. The package name is usually the same as the assembly and the name of the class that it provides prefixed by the namespace that it is added in. | + | Feature packages contain one specific feature, such as a data source, and can be added or removed from your product as needed. The package name is usually the same as the assembly and the name of the class that it provides is prefixed by the namespace that it is added in. |
- | ==== Dependancy Packages ==== | + | ==== Product Packages ==== |
- | Dependancy packages are third party dependancies that we have repackaged to references within our packages. There should never be a need to install these manually. | + | Product packages are a collection of packages used in specific products. Each product has a Standard version and a Barebone version which each provide different levels of features with Standard having most of the features that you will need and Barebone not including only the most basic features. You can install and uninstall feature packages as desired on top of these. You can see more about the coverage on each of the products on the product's coverage page. For example: [[map_suite_desktop_for_winforms_package_coverage|Map Suite Desktop For WinForms Package Coverage]]. |
+ | ==== Dependency Packages ==== | ||
- | For more information on which versions our dependancies are using click here: http://wiki.thinkgeo.com/wiki/map_suite_dependencies | + | Dependency packages are third party dependencies that we have repackaged to references within our packages. There should never be a need to install these manually. |
- | For more information on why we repackage please click here: http://wiki.thinkgeo.com/wiki/repackaged_nuget_packages | + | You can find more information on which versions our dependencies use [[map_suite_dependencies|here]]. |
- | ==== Product Packages ==== | + | ==== Why We Repackage ==== |
- | Product packages are a collection of packages used in specific products. Each product has a Standard version and a Barebones version which each provide different levels of features with Standard having most features that you will need and Barebones not including any but the most basic features. You can install and uninstall feature packages as desired on top of these. You can see more about the coverage on each of the products on the product's coverage page, for example: http://wiki.thinkgeo.com/wiki/map_suite_desktop_for_winforms_package_coverage. | + | The 3rd party dependencies included in the Dependency Packages are needed by our feature packages. Sometimes these packages can release updates that break compatibility with our APIs and some of the packages do not provide older versions for download. Because of these issues, we repackage the dependencies so that we have complete control of which versions of the dependency packages we use. |
- | ===== Production Builds through NuGet ===== | + | Repackaging also allows us to keep the dependencies for each of our feature packages well organized and consistent. |
- | Production builds in NuGet are our well-tested assemblies and for the most part the ones we suggest using. They all have a 3 number version number which relate to the Major Minor and Patch versions. For example, 10.1.2 where 10 is the major version, 1 is the minor version, and 2 is the patch version. | + | ===== Production Builds (Stable) through NuGet ===== |
+ | |||
+ | Production builds in NuGet are our well-tested assemblies and for the most part the ones we suggest using. They all have a three-number version number which relates to the Major, Minor, and Patch versions. For example, 10.1.2 where 10 is the major version, 1 is the minor version, and 2 is the patch version. | ||
==== Hotfix ==== | ==== Hotfix ==== | ||
- | Hotfixes are released when we want a code change to be immediately applied to the production build. These are generaly bug fixes and will rarely, if ever add features. There will be no API breaking changes and typically new APIs will not be added in a hotfix release. | + | Hotfixes are released when we want a code change to be immediately applied to the production build. These are generally bug fixes and will rarely, if ever add features. There will be no API breaking changes and typically new APIs will not be added in a hotfix release. |
==== Minor Release ==== | ==== Minor Release ==== | ||
Minor releases will be periodically released to add new features once they have been tested. These updates will also contain all of the hotfix changes released previously. For example 10.2.0 will include every change in hotfixes for the previous minor release version. | Minor releases will be periodically released to add new features once they have been tested. These updates will also contain all of the hotfix changes released previously. For example 10.2.0 will include every change in hotfixes for the previous minor release version. | ||
+ | |||
===== Daily Development Build (Unstable) through NuGet ===== | ===== Daily Development Build (Unstable) through NuGet ===== | ||
- | The Development Branch is built daily which means that new changes will be available the day after they are made. These versions will always have the latest features as we add them, but may not be tested fully yet, and the APIs for the new features may change through development. The version numbers for daily builds are the next major version suffixed with "beta" and a build number. For Example 11.0.0-Beta002. | + | The Development Branch is built daily which means that new changes will be available the day after they are made. These versions will always have the latest features as we add them, but may not be tested fully yet, and the APIs for the new features may change through development. The version numbers for daily builds are the next major version suffixed with "beta" and a build number. For example: 11.0.0-Beta002. |
- | If you want to install the daily builds for can follow these steps. | + | If you want to install the daily builds, you can follow these steps: |
- | - Ordered List Item Open NuGet Package Manager | + | - Open NuGet Package Manager |
- Input package you wish to install in the search field. | - Input package you wish to install in the search field. | ||
- Check "Include Prerelease" option to the right of the search field. | - Check "Include Prerelease" option to the right of the search field. | ||
- | - In the version dropdown select an option with a beta version listed, such as 11.0.0-Beta001. | + | - In the version dropdown, select an option with a beta version listed such as 11.0.0-Beta001. |
- Install using the install button. | - Install using the install button. | ||
- | {{mapsuite10:installing_prerelease_packages_on_nuget.png}} | + | {{mapsuite10:installing_prerelease_packages_on_nuget.png? }} |