20111010 agile minds - organize your chickens - nuget for the enterprise

APRIL 12, 2023 | SLIDE 1

ORGANIZE YOUR CHICKENSNuGet for the Enterprise


WHO ARE WE?

Maarten Balliauw Antwerp, Belgium www.realdolmen.com Focus on web

ASP.NET, ASP.NET MVC, PHP, Azure, … MVP Windows Azure (formerly ASP.NET)

http://blog.maartenballiauw.be @maartenballiauw


WHO ARE WE?

Xavier Decoster Antwerp, Belgium www.realdolmen.com Focus on web/ALM

Visual Studio, TFS, Scrum, ... Silverlight, ASP.NET, ASP.NET MVC, …

http://www.xavierdecoster.com @xavierdecoster

http://www.xavierdecoster.com/

https://twitter.com/#!/xavierdecoster


AGENDA

Chickens? NuGet Scenarios

Host your own NuGet repository Continuous (Package) Integration (Ab)using NuGet

Conclusion


WELCOME TO DLL HELLDependency Hell


WELCOME TO DEPENDENCY HELL

“A term for the frustration of software users who have installed software packages which have dependencies on specific versions of other software packages.”

Source: Wikipedia


CAUSE AND EFFECT

Reinventing the wheel We don’t need that dependency “If they can do it, we can do it, but better”

Marketing does the versioning People are waiting for v2 to buy Let’s call it v4 Platform Update SP3 November Edition

KB2348063 RTW Refresh

What happened to reuse of components?

We lost ownership of AssemblyVersion ?


PACKAGE MANAGEMENTUsing NuGet


PACKAGE MANAGEMENT

NuGet to the Rescue!

“NuGet is a Visual Studio extension that makes it easy to install and update open source libraries and tools in Visual Studio.”


PACKAGE WHAT?

Package Management

Simple concept Find Packages (Re)Use Packages Produce Packages

“…a collection of software tools to automate the process of installing, upgrading, configuring, and removing software packages…”

Source: Wikipedia

http://en.wikipedia.org/wiki/Package_management_system


GETTING STARTED

Tooling: NuGet Package Manager (http://nuget.org) NuGet Package Explorer (http://npe.codeplex.com) Install-Package NuGetPowerTools Install-Package NuGet.CommandLine

Guidance and documentation http://docs.nuget.org

http://nuget.org/

http://npe.codeplex.com/

http://docs.nuget.org/


CONSUMING PACKAGES

Simple as adding a reference


ONE DIALOG TO RULE THEM ALL…

Install-Package Update-Package Uninstall-Package

Settings Package Sources Local (offline) Cache location

Also: Manage packages on solution level! Right-click solution > Manage NuGet Packages…


NUGET PACKAGE MANAGER CONSOLE

PowerShell enabled!

Extensible! Scaffolding, NuGetPowerTools, … %UserProfile%\Documents\WindowsPowerShell\NuGet_profile.ps1


CONFIGURABLE PACKAGE SOURCES

Configurable through… NuGet Library Package Manager (VS add-in)

NuGet.config (in %APPDATA%\Roaming\NuGet\NuGet.config) NuGet.settings.targets (MSBUILD file part of NuGetPowerTools)


CREATING PACKAGES

What’s a package? Just a zip-file containing: … content and source code (to be injected into target project) … PowerShell scripts and executables … configuration file and source code transformations

http://docs.nuget.org/docs/creating-packages/Configuration-File-and-Source-Code-Transformations





PACKAGE CONVENTIONS

Conventions http://

docs.nuget.org/docs/creating-packages/Package-Conventions

Folder structure Tools (init.ps1, install.ps1, uninstall.ps1) Content Manifest (.nuspec file) Lib

http://docs.nuget.org/docs/creating-packages/Package-Conventions

http://docs.nuget.org/docs/creating-packages/Package-Conventions


NUGET MANIFEST SPECIFICATION

NuSpec manifest XML file (with XSD available) Package metadata


SEMANTIC VERSIONING

Think about your versioning! (semver.org)

Always specify lowerbound Use a version range (lowerbound + upperbound) when

versioning of package you depend on is messed up

Major Breaking changes

Minor Backwards compatible API additions/changes

Patch Bugfixes not affecting the API


ADVANCED USAGE SCENARIOS

Host your own NuGet repository Continuous (Package) Integration (Ab)using NuGet


HOSTING YOUR OWN REPOSITORY

Those chickens are mine!


HOSTING YOUR OWN REPOSITORY

NuGet = public feed Privacy Intellectual property

NuGet maintained by package authors Author removes v1.0.45 and you depend on it


SOLUTIONS

Folder / File share Orchard Gallery (or NuGet Gallery) NuGet.Server package MyGet


NUGET.SERVER DEMOInstall-Package NuGet.Server


NUGET.SERVER LIMITATIONS

Only 1 feed per installation No UI: up to you to build it No granular security: only 1 API-key for entire feed Conclusion: requires you to develop if you want

something more useful


MEET MYGET

www.myget.org NaaS

Register and off you go! (no dev)

Supports Enterprise scenarios Granular security Package mirroring

http://www.myget.org/


MYGET DEMOLog in to www.myget.org and get started


CONTINUOUS (PACKAGE) INTEGRATION

Fetch the chickens when you need them


TYPICAL SOURCE CONTROL...

Contains /References (if you are lucky) ...and also Project/_bin_deployable_assemblies ...and also /References/old ...and also /..././../.././References

Usually references GAC-ed assemblies


DEPENDENCIES

Software has dependencies. Deal with it.

But are those YOUR intellectual property? YOUR reason to build software? YOUR product?

No. They are dependencies. And they don’t belong in source control.


CONTINUOUS (PACKAGE) INTEGRATION

Can I get rid of all these referenced assemblies duplicated all-over my source control system?Yes!

Do I need to install and maintain NuGet on all my build agents?No!


NUGETPOWERTOOLS DEMOOrganize your build chickens!


3RD PARTIES DON’T BELONG IN YOUR SCM

Source control bloated with third-party binaries? Replace them with NuGet packages

Commit packages.config/repositories.config files Preferably not the packages

Use NuGetPowerTools Enable-PackageRestore


PROBLEM!

NuGet feed is subject to change... PackageSource MSBuild property to the rescue NuGet.settings.targets in $(SolutionDir)\.nuget folder

Now what... Host your own feed and mirror third-party packages

Internal NuGet.Server Network Share

Or use MyGet for that


ORGANIZE YOUR CHICKENS

Feed structuring Scoped by quality: Build, QA, Production, … Scoped by audience: public, restricted access Other:

Scoped by product version, milestone… Scoped by target platform


(AB)USING NUGET


GUIDANCE

Publishing a package brings great responsibility Breaking changes in your packages should be versioned

accordingly! Consumers might choose to no longer consume any packages

you published


GUIDANCE

Package Integration ≠ Integration Testing CI builds reflect output of source control input Same input always produces same output

Do not auto-update packages during automated builds!


(AB)USING NUGET?

Change of perspective

NuGet as a package manager

NuGet as a protocol for distributing packages


EXTENDING NUGETScaffolding, CmdLets, Plug-ins, …


SCAFFOLDING

T4, Mvc, … Create your own PowerShell cmdlets Automate Visual Studio (access to DTE)


AUTOMATE DEPLOYMENTS

Build results in .nupkg Octopus deploys to its tentacles

Test tentacles Staging tentacles Production tentacles

www.octopusdeploy.com


NUGET COMMAND LINE PLUG-INS

Extend NuGet.exe Custom Commands

How? Build class library Reference NuGet.exe Inherit Command Deploy your dll to %LocalAppData%\NuGet\Commands


CHOCOLATEY

NuGet developer library packages

Chocolatey applications and tools packager “yum” or “apt-get” for Windows

www.chocolatey.org


CHOCOLATEY DEMONuGet desert


ORCHARD / WEBMATRIX / …

NuGet not bound to VS Orchard CMS: modules & themes WebMatrix: install page helpers on the fly Your app: offer plugins through a repo


CONCLUSION

www.visug.be

• Dependencies & people are chickensDeal with them! NuGet can help

• Set up your own NuGet repository for various reasons

• Continuous package integration

• NuGet is a package managerNuGet is a protocol

Conclusion


THANK YOU!Any questions?

http://blog.maartenballiauw.be @maartenballiauw

http://www.xavierdecoster.com@xavierdecoster

20111010 agile minds - organize your chickens - nuget for the enterprise

Technology

nuget gallery nuget

package management nuget

nuget package manager

nuget package explorer

repository nuget

nuget scenarios

versioning of package

installpackage updatepackage