Skip to content
Azure DevOps extention that adds advance capabilities for Artifactory Promotion task only.
TypeScript JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
buildScripts
images
tasks/Artifactory-Promoter
.gitignore
LICENSE
README.md
overview.md
package-lock.json
package.json
tsconfig.json
vss-extension.json

README.md

About this project

"Artifactory Promotion" is an Azure DevOps extension that adds advance capabilities for the Artifactory promotion task only. This tasks copies or moves artifacts from one repository to another within the same server, using the build properties associated in the Release Pipeline. What makes this task unique is that it does not promote all of the build's artifacts, but only those for a defined source. So in case your build produces two types of artifacts into two separate artifactory repositories, but you only want to promote one artifact type, now you can promote just that one artifact instead of both artifacts sourced from two repositories and end up in the same target repository, which is wrong.

Where to find and use it

This extension can be used with the Azure DevOps online service (formerly VSTS) and the Azure DevOps on-premise server (formerly TFS on premise). It can be found in the Azure DevOps Marketplace. In order to use this extension for your on-premise Azure DevOps server please follow these instructions. This extension was created using Node.js, so this extension is platform independent and leverages the Artifactory REST API only.

Building

npm run-script preinstall

npm run-script install

npm run-script build

I need to resolve the build errors, but you can ignore those for now.

Create the extension

Be sure to manually increment the version number befor executing the create step in the files:

  • vss-extension.json
  • task\Artifactory-Promoter\task.json

Then execute:

npm run-script create

The finished package will be placed in the root of the project and be named "MacrossPlusInc.artifactory-promoter-extension-X.X.X.vsix" where "X.X.X" is the version number.

Testing

I have not included tests with this project, for right now.

How to use the extension

Requirements

This extension depends on the "Artifactory" service connection to be present. This is installed by the JFrog Artifactory extension. Since the Artifactory Promoter extension relies on build information in the Artifactory server and that is stored using the JFrog Artifactory extension, then it is a safe bet to assume that the service connection exists, so my extension makes use of it (no need to create duplicate service connections).

Adding the step

In your Release Pipeline add a Step. Under the "Utility" find "Artifactory Promoter" and add it to your deployment step.

ExtensionForm

  1. Display name = Default is "Artifactory Promoter", but you can change it to anything.

  2. Artifactory service is required. If you are familiar with JFrog's existing extension, then it will just utilize the existing connection entry. Click on the "Manange" link to go create a connection to your Artifactory server and enter the credentials.

  3. Source repository = the source that will be search for any associated build artifacts used in the Release Pipeline. This is required.

  4. Target repository = the target Artifactory repository that the artifactory will be copied or movied to. The folder structure placement will be kept the same. This is required.

  5. Status = A free-form text entry that you can use to define the Event or Stage of your artifact. It can be "Deployed", "Released", "Staged", or whatever your prefer. Default is "Deployed".

  6. Comment = Another free-form text entry that you can use to give to the promotion within Artifactory. Default is empty.

  7. Method of Promotion = A dropdown list to choose from the values of either Copy or Move. Copy will leave the original artifact in the source repository and make a duplicate copy in the target repository. Move will remove the artifact from the source repository and place it in the target repository. Default is Copy.

  8. Promote Artifacts = Checkbox to choose if you want to just leave the artifacts in place and create a Release History in Artifactory only that is associated with the Build Information that was published during the Build Pipeline. Default is true.

  9. Dry run = Will execute all the tasks, but not copy/move any artifacts, nor create a Release History. Default is false.

  10. Fail Fast = Will fail and abort the operation upon receiving an error. Default is true.

What the extension does

For this example, this extension will search for the build "RA-Common", and the build number "RA-Common-1.0.0", and for any associated artifacts in the repository "biztalk-msi-build-local". The artifacts associated with the build are these:

ExtensionForm

But the artifact returned will only be the MSI package. Now that MSI package is copied to the target repository:

ExtensionForm

Notice that the directory structure is kept the same.

Now that all the artifacts have been promoted, a promotion entry is created and associated with the build in Artifactory:

ExtensionForm

If you go into your Release Pipeline and then into the logs of the release steps this will be your log

ExtensionForm

YOU ARE DONE!

Who I want to thank

I want to thank JFrog for making a great product that enjoy using. This is my very first VSTS/Azure DevOps extension so I expect to have gotten many things wrong. I want to thank JFrog again because I took their extension source code apart to see how it was put together and in general how to create an extension. And I couldn't have done this without Google searches, Stackoverflow, and GitHub. I had a ton of questions and roadblocks so I want to give back to the community that has given me so much. I FREAKING ENJOY DEVOPS!

What is Artifactory

Learn more about what a great product Artifactory can be for your organization. Are you using a network share for your build artifact needs and it getting unwieldy? Need a place to store NuGet packages? Need an automated process to clean-up pre-release artifacts without having you need to worry about it? Need to secure those releases for a long time and make sure no one deletes them? Need structure in a chaotic world? Try Artifactory.

You can’t perform that action at this time.