A Gulp wrapper for octopack library to push projects to Octopus Deploy
Install with npm
npm install --save-dev @octopusdeploy/gulp-octo
Optional parameter to define the package type. Valid values are
zip. If not provided this defaults to
Id component of the created package. By default it will extract the name out of
package.json if present.
version component of the created package. By default it will extract the version out of
package.json if present.
Required property that points to the Octopus Server instance the package should be pushed to. Note that this is not the full path of the package upload url, but just the root url of the server instance. The approprate path will be appended within in the push module.
Flag to force overwrite of existing package if one already exists with the same ID and version.
Key linked to account with
options.replace is set to true and a package with the same ID and version already exists then the
BuiltInFeedAdminister permission is required.
In this example, the default options are used to create a package and save to the bin directory.
var gulp = ;var octopack = pack;// Simple package into bin directorygulp;
In this example, the default options are used to push a package that is generated from some other process. This example provide the minimum configuration options required to perform the push.
var gulp = ;var octopush = push;// Simple publish with existing packagegulp;
Pack & Push
In this example, the project files are first packaged up into a
.tar.gz file which is then piped directly to the push module.
var octo = ;gulp;
Copyright (c) 2015 Octopus Deploy firstname.lastname@example.org
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.