Merge pull request #134 from coloursofnoise/main

Allow user-specified reasonFilter for retrieving builds

README.md

@@ -46,6 +46,11 @@ Every Azure Pipeline has a numerical identifier that is part of the URL. For exa
 
 Pipelines can have an arbitrary number of artifacts, which are identified by a name. The `artifact` parameter specifies which one to download. It can be omitted if the given Pipeline run has only one artifact attached to it.
 
+### Build filters
+
+The `reasonFilter` parameter can be added to filter by the reason for a build.
+A list of accepted reasons can be found [here](https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/list?view=azure-devops-rest-6.0#buildreason). This parameter defaults to `all` if omitted.
+
 ### Strip prefix
 
 Pipeline artifacts can contain entire directory structures. The `stripPrefix` parameter allows filtering by a given path prefix; Any files matching that prefix will be written (after stripping the prefix), all other files will be skipped.

action.yml

@@ -28,6 +28,10 @@ inputs:
     required: false
     description: 'Use @actions/cache to accelerate this Action'
     default: 'true'
+  reasonFilter:
+    required: false
+    description: 'Filter results by the reason for the build; Defaults to "all"'
+    default: 'all'
 runs:
   using: 'node12'
   main: 'dist/index.js'

main.ts

@@ -15,7 +15,8 @@ async function run(): Promise<void> {
       core.getInput('repository'),
       core.getInput('definitionId'),
       core.getInput('artifact'),
-      core.getInput('stripPrefix')
+      core.getInput('stripPrefix'),
+      core.getInput('reasonFilter')
     )
     const outputDirectory = core.getInput('path') || artifactName
     let useCache = core.getInput('cache') === 'true'

src/downloader.ts

@@ -115,7 +115,8 @@ export async function get(
   repository: string,
   definitionId: string,
   artifactName: string,
-  stripPrefix?: string
+  stripPrefix?: string,
+  reasonFilter = 'all'
 ): Promise<{
   artifactName: string
   stripPrefix: string
@@ -137,7 +138,7 @@ export async function get(
     count: number
     value: [{id: string; downloadURL: string}]
   }>(
-    `${baseURL}?definitions=${definitionId}&statusFilter=completed&resultFilter=succeeded&$top=1`
+    `${baseURL}?definitions=${definitionId}&statusFilter=completed&resultFilter=succeeded&reasonFilter=${reasonFilter}&$top=1`
   )
   if (data.count !== 1) {
     throw new Error(`Unexpected number of builds: ${data.count}`)