Chauffeur.CreatedPackages 1.0.5

Chauffeur.CreatedPackages

This package is an add-on to the chauffeur runner. It provides two new deliverables

1. Package List (package-list, pl) Provides a list of all created packages, shows the umbraco created package ID, its unique identifier and the title

2. Package Create (package-create, pc) Creates a package for the given umbraco created package ID (retrieved using package-list) This triggers the umbraco package publish command and creates an umbraco package zip in the media directory.

3. Package Set Version (package-set-version, pkg-set-ver, pkg-ver, pv) Sets the version attribute of all created packages in the packages.config.

Purpose

The purpose of these deliverables are to allow a CI pipeline to create an umbraco package. I looked through all the solutions on how to build a package using npm, powershell and generally picking apart and working around the umbraco framework.

After discovering chauffeur and its main purpose being to handle CI/CD for project deployment I dug in a little further and found that it worked great for deploying umbraco (and started using it for deploying sites), but didnt cover the use case of deploying and version controlling created packages.

We wanted a way to use umbraco to create a package, but then use a build system to package and deploy a change.

Using created packages

This is just one example of how to use the tool Spin up a new copy of umbraco (check out yo umbraco-cms for a tool that uses chauffeur to get you up and running fast). Then develop your package (doc types, macros, etc). Use the umbraco package manager to save your package, choose all the files and database settings you want to store, then check that the package appears in chauffeur.

Chauffeur.Runner.exe package-list
1) testpackage [25ed2aac-c059-410d-8a2e-7f740776daa3]

When you are finished, use chauffeur to scaffold the site. Choose all the default options

Chauffeur.Runner.exe scaffold
Time to setup Chauffeur!
What do you want the name to be (001-Setup)?
Include an install step (Y/n)?
Do you want to package your current instance (Y/n)?
Chauffeur is all setup and ready to go. To run your first delivery just run:
./Chauffeur.Runner.exe delivery -p:adminpwd=MySuperSecretPassword! -p:packageVersion=1.2.3.4

Edit the generated App_Data\Chauffeur\setup-001.delivery, and add

package-set version X as a new line (where X is the version number you want to create)

package-create N as a new line (where N is the package to create)

install y
user change-password admin $adminpwd$
package 001-Setup
package-set-version $packageVersion$
package-create 1

Check your umbraco site into source control. Dont add the .sdf file, make sure the created_packages directory and the chauffeur directory are checked in

\App_Data\packages\created\createdpackages.config
\App_Data\Chauffeur

If you've used a generated .gitignore file, it usually ignores the App_Data directory, so check these files are in version control.

Now you can use your favourite build tool to download umbraco, nuget restore the packages (including the chauffeur.createdpackages package), build umbraco and then run

Chauffeur.Runner.exe delivery -p:adminpwd=MySuperSecretPassword! -p:packageVersion=1.2.3.4

This will make chauffeur install umbraco to a .sdf file, restore your site (because you scaffolded it) and then create the package you requested. You'll need to write something to pass your version number into the package version (you should probably change the adminpwd whilst you are at it) but once done you'll have a versioned package you can deploy.