Fork off the get-azure-pipelines-artifact Action

Much of what the `setup-git-for-windows-sdk` Action does is to download
an artifact (in a robust fashion, retrying a couple times if necessary)
and caching it.

This is useful for other things, too.

Let's transmogrify the Action that is rather specific for Git for
Windows' use case to allow downloading arbitrary artifacts from
arbitrary Azure Pipelines.

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>

Author: dscho

.github/workflows/test.yml

@@ -10,7 +10,7 @@ on: # rebuild any PRs and main branch changes
 
 jobs:
   build: # make sure build/ci work properly
-    runs-on: windows-latest
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - run: npm ci
@@ -27,30 +27,14 @@ jobs:
             exit 1
           }
   test: # make sure the action works on a clean machine without building
-    runs-on: windows-latest
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - name: Run this Action in-place
         uses: ./
-      - name: Verify that the Bash of Git for Windows' SDK is used
+        with:
+          repository: git/git
+          definitionId: 10
+      - name: Verify that the package was downloaded
         shell: bash
-        run: |
-          set -x
-          echo "This is the MSYS2 pseudo root: $(cygpath -aw /)"
-          test "gcc is /mingw64/bin/gcc" = "$(type gcc)"
-          test "prove is /usr/bin/core_perl/prove" = "$(type prove)"
-          prove -V
-          printf '%s\n' \
-            "#include <stdio.h>" \
-            '' \
-            'int main()' \
-            '{' \
-            '  printf("Hello, world!\n");' \
-            '  return 0;' \
-            '}' >hello-world.c
-          gcc -o hello-world.exe hello-world.c
-          hello="$(./hello-world.exe)"
-          test 'Hello, world!' = "$hello"
-
-          # Verify that the locale is set, enabling `grep -P` to work
-          test 123 = "$(printf '1248\n123\n' | grep -P '2(?!4)')"
+        run: test -f sparse/sparse_*.deb

.gitignore

@@ -98,5 +98,5 @@ Thumbs.db
 __tests__/runner/*
 lib/**/*
 
-# Ignore downloaded 64-bit minimal SDK
-/git-sdk-64-minimal/
+# Ignore downloaded artifact
+/sparse_*.deb

.vscode/settings.json

@@ -1,19 +1,14 @@
 {
     "cSpell.ignoreRegExpList": [
-        "CHERE_INVOKING",
-        "LC_CTYPE",
-        "SDK's",
-        "makepkg-git",
-        "mingw-w64-git",
-        "mingw32",
-        "mingw64",
+        "INPUT_DEFINITIONID",
+        "arrowParens",
         "vstfs://.*"
     ],
     "cSpell.words": [
         "Backoff",
-        "MSYSTEM",
-        "Pacman",
         "autodrain",
+        "dpkg",
+        "refname",
         "unzipper",
         "vercel"
     ],

README.md

@@ -1,77 +1,61 @@
-# Set up a Git for Windows SDK (or a subset thereof)
+# Download an artifact from an Azure Pipeline
 
-Use this Action to initialize an environment to develop Git for Windows.
+Use this Action to download an artifact from an Azure Pipeline.
 
 ## Getting Started
 
 ```yaml
-name: Build stuff in Git for Windows' SDK
+name: Download stuff from an Azure Pipeline
 on: [push]
 jobs:
   build:
-    runs-on: windows-latest
+    runs-on: ubuntu-16.04
     steps:
-    - uses: actions/checkout@v2
-    - name: Setup Git for Windows' minimal SDK
-      uses: git-for-windows/setup-git-for-windows-sdk@v1
-    - name: Build
-      shell: bash
-      run: make
+    - name: Download a build artifact from an Azure Pipeline
+      uses: git-for-windows/get-azure-pipelines-artifact@v0
+      with:
+        repository: git/git
+        definitionId: 10
+        artifact: sparse
+    - run: sudo dpkg -i sparse_*.deb
 ```
 
 ## Input parameters
 
-### Available flavors
+### Repository
 
-This Action supports several flavors (read: subsets) of the Git for Windows SDK that can be configured like this:
+This Action needs to know in which repository the artifact lives. Example: [https://dev.azure.com/git/git/_build](https://dev.azure.com/git/git/_build) shows the Azure Pipelines of the `git/git` repository. It can be configured like this:
 
 ```yaml
-- uses: git-for-windows/setup-git-for-windows-sdk
+- uses: git-for-windows/get-azure-pipelines-artifact@v0
   with:
-    flavor: build-installers
+    repository: git/git
 ```
 
-The supported flavors are:
+### Pipeline definition ID
 
-- `minimal`:
-
-  This is the most useful flavor to build Git for Windows' source code and run its own test suite. Only available for x86_64.
-
-- `makepkg-git`:
-
-  This flavor allows packaging `mingw-w64-git`, the Pacman package. It is only available for x86_64 but can be used to "cross-compile" for i686.
-
-- `build-installers`:
-
-  In addition to building `mingw-w64-git`, this flavor allows bundling Git for Windows' artifacts such as the installer and the Portable Git.
-
-- `full`:
-
-  This is the "full" SDK, [as users would install it](https://gitforwindows.org/#download-sdk), with a pre-selected set of packages pre-installed. Additional packages can be installed via `pacman -S <package>`.
-
-### CPU architecture support
-
-Git for Windows SDK comes in variants  targeting `x86_64` (AKA "64-bit") and `i686` (AKA 32-bit). The default is `x86_64` and can be overridden like this:
+Every Azure Pipeline has a numerical identifier that is part of the URL. For example, the "Build sparse for Ubuntu" Pipeline in `git/git` at [https://dev.azure.com/git/git/_build?definitionId=10](https://dev.azure.com/git/git/_build?definitionId=10) has the identifier `10`. It needs to be configured via the `definitionId` key.
 
 ```yaml
-- uses: git-for-windows/setup-git-for-windows-sdk
+- uses: git-for-windows/get-azure-pipelines-artifact@v0
   with:
-    flavor: build-installers
-    architecture: i686
+    definitionId: 10
 ```
 
-Please note that only the `build-installers` and the `full` flavors are available for `i686`.
+### Artifact name
 
-### Verbosity
+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.
 
-By default, this Action prints a line whenever 250 items were extracted (this does not work for the `full` flavor, where this Action is silent by default). It can be overridden by setting the input parameter `verbose`; setting it to a number will show updates whenever that many items were extracted. Setting it to `false` will suppress progress updates. Setting it to `true` will print every extracted file (this also works for the `full` flavor).
+### Output location
+
+By default, the artifact files will be stored in the current directory. The `path` parameter can be used to override that.
+
+This directory needs to be unless caching is turned off.
 
 ### Caching
 
 To accelerate this Action, artifacts are cached once downloaded. This can be turned off by setting the input parameter `cache` to `false`.
 
-In practice, caching the `full` artifacts does not provide much of a speed-up. Instead, it slows it down by adding several minutes during with the artifact is cached. Therefore, caching is disabled for the `full` artifacts by default, corresponding to `cache: auto`.
-
 ## Developing _this_ Action
 
 > First, you'll need to have a reasonably modern version of `node` handy, such as Node 12.
@@ -92,26 +76,4 @@ Run the tests :heavy_check_mark:
 
 ```bash
 $ npm test
-
-> setup-git-for-windows-sdk@0.0.0 test C:\Users\me\setup-git-for-windows-sdk
-> jest
-
-PASS __tests__/main.test.ts (28.869 s)
-  √ skipping tests requiring network access (224 ms)
-
-  console.log
-    If you want to run tests that access the network, set:
-    export RUN_NETWORK_TESTS=true
-
-      at __tests__/main.test.ts:26:13
-
-PASS __tests__/downloader.test.ts (29.889 s)
-  √ can obtain build ID (9 ms)
-
-Test Suites: 2 passed, 2 total
-Tests:       2 passed, 2 total
-Snapshots:   0 total
-Time:        31.11 s
-Ran all test suites.
-...
 ```

__tests__/downloader.test.ts

@@ -49,7 +49,7 @@ test('can obtain build ID', async () => {
   mocked(fetch).mockReturnValue(
     Promise.resolve(new Response(JSON.stringify(buildIdResponse)))
   )
-  const {id} = await get('minimal', 'x86_64')
+  const {cacheId} = await get('git-for-windows/git', '22', 'git-sdk-64-minimal')
   expect(fetch).toHaveBeenCalledTimes(1)
-  expect(id).toEqual('git-sdk-64-minimal-71000')
+  expect(cacheId).toEqual('git-for-windows/git-22-git-sdk-64-minimal-71000')
 })

__tests__/main.test.ts

@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import {statSync} from 'fs'
+import fs from 'fs'
 import * as process from 'process'
 import * as child_process from 'child_process'
 import * as path from 'path'
@@ -28,35 +28,28 @@ if (process.env.RUN_NETWORK_TESTS !== 'true') {
     )
   })
 } else {
-  // shows how the runner will run a javascript action with env / stdout protocol
-  test('cannot download 32-bit minimal SDK', async () => {
-    expect(
-      await runAction({
-        env: {
-          INPUT_FLAVOR: 'minimal',
-          INPUT_ARCHITECTURE: 'i686'
-        }
-      })
-    ).toEqual(1)
-  })
-
   jest.setTimeout(5 * 60 * 1000) // this can easily take a minute or five
 
-  test('extract the 64-bit minimal SDK', async () => {
-    const outputDirectory = `${__dirname}/../git-sdk-64-minimal`
+  test('download `sparse` artifact', async () => {
+    const getSparsePackages = async (): Promise<string[]> => {
+      const files = await fs.promises.readdir('.')
+      return files.filter(e => e.match(/^sparse_.*\.deb$/))
+    }
+
+    for (const sparsePackage of await getSparsePackages()) {
+      await fs.promises.rm(sparsePackage)
+    }
+
     expect(
       await runAction({
         env: {
-          INPUT_FLAVOR: 'minimal',
-          INPUT_ARCHITECTURE: 'x86_64',
-          INPUT_PATH: outputDirectory,
-          INPUT_VERBOSE: '250',
+          INPUT_REPOSITORY: 'git/git',
+          INPUT_DEFINITIONID: '10',
+          INPUT_VERBOSE: 'true',
           INPUT_CACHE: 'true'
         }
       })
     ).toEqual(0)
-    expect(
-      statSync.bind(null, `${outputDirectory}/mingw64/bin/gcc.exe`)
-    ).not.toThrow()
+    expect(await getSparsePackages()).toHaveLength(1)
   })
 }

action.yml

@@ -1,30 +1,30 @@
-name: 'Setup Git for Windows SDK'
-description: 'Set up an environment to develop Git for Windows'
+name: 'Download an artifact from an Azure Pipeline'
+description: 'Download an artifact from an Azure Pipeline'
 author: 'Johannes Schindelin'
 branding:
   icon: fast-forward
   color: blue
 inputs:
-  flavor:
+  repository:
+    required: true
+    description: 'The repository in which the Azure Pipeline lives'
+  definitionId:
+    required: true
+    description: 'The identifier of the Azure Pipeline'
+  artifact:
     required: false
-    description: 'The subset (if any) of the SDK: minimal, makepkg-git, build-installers, or full'
-    default: 'minimal'
-  architecture:
-    required: false
-    description: 'The architecture of the SDK: x86_64 or i686'
-    default: 'x86_64'
+    description: 'The name of the Azure Pipeline artifact'
   path:
     required: false
-    description: 'Where to write the SDK files'
-    default: ''
+    description: 'Where to write the artifact file(s)'
   verbose:
     required: false
     description: 'Whether to log files as they are extracted'
     default: '250'
   cache:
     required: false
     description: 'Use @actions/cache to accelerate this Action'
-    default: 'auto'
+    default: 'true'
 runs:
   using: 'node12'
   main: 'dist/index.js'