Deploying software with Octopus often involves deploying packages. This section explains how to package your applications for deployment with Octopus.
Before you can deploy a package you need to:
- Give your package a package ID.
- Choose and apply a versioning scheme.
- Create the package in a supported format.
- Host the package in a package repository.
Package ID
Package IDs must conform to the following specifications:
- Package IDs must be unique within your Octopus Deploy instance.
- Package IDs consist of one or more segments separated by one of the following separator characters:
-._. - Segments contain only alphanumeric characters.
For instance, the package ID in this sample package is hello-world.
Avoid using numbers in your package ID as it could result in the version number being incorrectly parsed.
Version numbers
Octopus supports Semantic Versioning, unless you are deploying artifacts to a Maven repository in which case you will need to use Maven Versions.
The version number needs to be applied to your package after the package ID and before the format. For instance. The version number in our sample package is 1.0.0.
Learn more about versioning schemes.
Package dependencies and structure
When you package your applications, you need to include all the binaries that are required to run the application, and structure the package the way you want it to appear after it has been extracted.
Supported formats
It is important that your packages have the correct file extension because Octopus uses the file extension to determine the correct extraction algorithm to use with your packages. Only NuGet packages will have extra metadata like release notes and description extracted from the package metadata.
| Package type | File Extensions | Built-in repository | External feed | Notes on external feeds |
|---|---|---|---|---|
| NuGet | .nupkg | Yes | Yes | Learn about NuGet on the official NuGet website. |
| Zip | .zip | Yes | Yes | |
| JAR WAR EAR RAR | .jar, .war, .ear, .rar | Yes | Yes | Learn about Maven Feeds and Octopus. RAR files a Java Resource Adaptor files, not compressed archive formats. |
| Tar | .tar | Yes | Yes | |
| Tar + Gzip | .tgz, .tar.gz, .tar.Z | Yes | Yes | |
| Tar + Bzip2 | .tar.bz, .tar.bz2, .tbz* | Yes | ||
| Docker Image | Yes | Docker Registries. Learn about Docker and Octopus. | ||
| Helm Chart | .tgz | Yes | Yes | Helm Chart Repositories. Learn about Helm and Octopus. |
Learn more
Help us continuously improve
Please let us know if you have any feedback about this page.
Page updated on Thursday, December 16, 202