I work for Microsoft as an App Innovation Cloud Solution Architect in the UK. The posts and comments on this site are my own opinions and are not endorsed in any way by my employer.

Promoting Maven Packages to Release Views using the Azure DevOps Artifacts REST API.

WARNING: I can’t find any reference to this API in any of the official documentation, it is consumed by the azure devops site so should be fairly stable but could be changed without warning. Use at your own risk!

ADDITIONAL WARNING: I am not a Java/Maven developer, I am happy to take recommendations for how to improve this process.

PROBLEM: How do I promote my Maven Package to a PreRelease/Release view in Azure DevOps Artifacts with a script?

Azure DevOps artifacts has the ability to promote Packages between different states, this is useful if you want to test different versions of a package with limited audiences (who accept the risk).

If you want make this part of your CI/CD pipeline you run into challenges, a marketplace extension exists (link)but this is only supported for NPM/Nuget packages (and not Maven).

Digging into the repo associated with the extension and this excellent blog post I found that it is using the DevOps REST API under the hood. However the reason it only supports NPM and Nuget is that there is no PATCH REST API for maven Sad smile

So how is the Portal doing it? Lets inspect the traffic (F12 Network tab in a Chromium browser).

It looks like there is an API called packagesBatch that does the update. So lets try to call it with a PAT token (instructions here).

POST https://pkgs.dev.azure.com/{{DEVOPS_ORG}}/{{DEVOPS_PROJECT_GUID}}/_apis/packaging/feeds/{{DEVOPS_FEED_GUID}}/maven/packagesBatch
Content-Type: application/json
accept: application/json;api-version=5.0-preview.1;excludeUrls=true;enumsAsNumbers=true;msDateFormat=true;noArrayWrap=true
Authorization: Basic :{{DEVOPS_PAT_TOKEN}}

{
    "data":
    {
        "viewId":"{{DEVOPS_FEED_VIEW_RELEASE_GUID}}"
    },
    "operation":0,
    "packages":[
        {
            "group":"{{ARTIFACT_GROUP_NAME}}",
            "artifact":"{{ARTIFACT_NAME}}",
            "version":"{{ARTIFACT_VERSION}}"
        }
    ]
}

That seems to work! Now by changing the viewId to the release GUID we can promote to that view too.

Here is the sample payload for my request..

{
    "data":
    {
        "viewId":"0b1177ed-e3b3-46c5-a42c-7a3420ae109c"
    },
    "operation":0,
    "packages":[
        {
            "group":"com.memoryleek.javaexperiments","artifact":"maven-test",
            "version":"1.2.168"
        }
    ]
}

You can use the standard REST API to get the Project GUID, the Feed GUID and the Feed View GUIDs. (requests shown below). The DEVOPS org can be seen when you sign into the portal.

#Get the Project GUID
GET https://dev.azure.com/{{DEVOPS_ORG}}/_apis/projects?api-version=6.0-preview.4
Authorization: Basic :{{DEVOPS_PAT_TOKEN}}

###

#Get the Feed GUID
GET https://feeds.dev.azure.com/{{DEVOPS_ORG}}/{{DEVOPS_PROJECT_GUID}}/_apis/packaging/feeds?api-version=6.0-preview.1
Authorization: Basic :{{DEVOPS_PAT_TOKEN}}

###

#Get the Feed View GUIDs
GET https://feeds.dev.azure.com/{{DEVOPS_ORG}}/{{DEVOPS_PROJECT_GUID}}/_apis/packaging/Feeds/{{DEVOPS_FEED_GUID}}/views?api-version=6.0-preview.1
Authorization: Basic :{{DEVOPS_PAT_TOKEN}}