Update the readme (#473)

* Update the readme

* Update upload artifact versions

* Add back the GHES support note

* Update the skip-decompress description

* Be more specific with the direct download example

* Add GHES support section to TOC

.eslintignore

@@ -1,3 +0,0 @@
-node_modules/
-lib/
-dist/

.eslintrc.json

@@ -1,16 +0,0 @@
-{
-    "env": { "node": true, "jest": true },
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": { "ecmaVersion": 9, "sourceType": "module" },
-    "extends": [
-      "eslint:recommended",
-      "plugin:@typescript-eslint/eslint-recommended",
-      "plugin:@typescript-eslint/recommended",
-      "plugin:import/errors",
-      "plugin:import/warnings",
-      "plugin:import/typescript",
-      "plugin:prettier/recommended",
-      "prettier/@typescript-eslint"
-    ],
-    "plugins": ["@typescript-eslint"]
-}

.github/workflows/check-dist.yml

@@ -10,11 +10,7 @@ on:
   push:
     branches:
       - main
-    paths-ignore:
-      - '**.md'
   pull_request:
-    paths-ignore:
-      - '**.md'
   workflow_dispatch:
 
 jobs:
@@ -22,12 +18,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Setup Node 16
-        uses: actions/setup-node@v3
+      - name: Setup Node 24
+        uses: actions/setup-node@v4
         with:
-          node-version: 16.x
+          node-version: 24.x
           cache: 'npm'
 
       - name: Install dependencies
@@ -46,7 +42,7 @@ jobs:
         id: diff
 
       # If index.js was different than expected, upload the expected version as an artifact
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         if: ${{ failure() && steps.diff.conclusion == 'failure' }}
         with:
           name: dist

.github/workflows/codeql-analysis.yml

@@ -20,7 +20,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL

.github/workflows/licensed.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     name: Check licenses
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: npm ci
       - name: Install licensed
         run: |

.github/workflows/publish-immutable-actions.yml

@@ -0,0 +1,20 @@
+name: 'Publish Immutable Action Version'
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+      packages: write
+
+    steps:
+      - name: Checking out
+        uses: actions/checkout@v4
+      - name: Publish
+        id: publish
+        uses: actions/publish-immutable-action@0.0.3

.github/workflows/release-new-action-version.yml

@@ -21,7 +21,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Update the ${{ env.TAG_NAME }} tag
-      uses: actions/publish-action@v0.2.1
+      uses: actions/publish-action@v0.3.0
       with:
         source-tag: ${{ env.TAG_NAME }}
         slack-webhook: ${{ secrets.SLACK_WEBHOOK }}

.github/workflows/test.yml

@@ -8,7 +8,6 @@ on:
       - '**.md'
 
 jobs:
-
   build:
     name: Build
 
@@ -21,13 +20,12 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
-    # using node 16 since that is what the latest version of the runner ships with
-    - name: Setup Node 16
-      uses: actions/setup-node@v3
+    - name: Setup Node 24
+      uses: actions/setup-node@v4
       with:
-        node-version: 16.x
+        node-version: 24.x
         cache: 'npm'
 
     - name: npm install
@@ -40,41 +38,42 @@ jobs:
       run: npm run lint
 
     - name: Format
-      run: npm run format-check 
+      run: npm run format-check
+
+    - name: Run Unit Tests
+      run: npm test
 
-    # Test end-to-end by uploading two artifacts and then downloading them
-    # Once upload-artifact v2 is out of preview, switch over
     - name: Create artifacts
       run: |
         mkdir -p path/to/artifact-A
         mkdir -p path/to/artifact-B
         echo "Lorem ipsum dolor sit amet" > path/to/artifact-A/file-A.txt
         echo "Hello world from file B" > path/to/artifact-B/file-B.txt
-    
+
     - name: Upload artifact A
-      uses: actions/upload-artifact@v1
+      uses: actions/upload-artifact@v4
       with:
-        name: 'Artifact-A'
+        name: Artifact-A-${{ matrix.runs-on }}
         path: path/to/artifact-A
 
     - name: Upload artifact B
-      uses: actions/upload-artifact@v1
+      uses: actions/upload-artifact@v4
       with:
-        name: 'Artifact-B'
+        name: Artifact-B-${{ matrix.runs-on }}
         path: path/to/artifact-B
 
     # Test downloading a single artifact
-    - name: Download artifact A
+    - name: Download artifact A (absolute path)
       uses: ./
       with:
-        name: 'Artifact-A'
+        name: Artifact-A-${{ matrix.runs-on }}
         path: some/new/path
 
     # Test downloading an artifact using tilde expansion
-    - name: Download artifact A
+    - name: Download artifact A (tilde expansion)
       uses: ./
       with:
-        name: 'Artifact-A'
+        name: Artifact-A-${{ matrix.runs-on }}
         path: ~/some/path/with/a/tilde
 
     - name: Verify successful download
@@ -99,8 +98,8 @@ jobs:
 
     - name: Verify successful download
       run: |
-        $fileA = "some/other/path/Artifact-A/file-A.txt"
-        $fileB = "some/other/path/Artifact-B/file-B.txt"
+        $fileA = "some/other/path/Artifact-A-${{ matrix.runs-on }}/file-A.txt"
+        $fileB = "some/other/path/Artifact-B-${{ matrix.runs-on }}/file-B.txt"
         if(!(Test-Path -path $fileA) -or !(Test-Path -path $fileB))
         {
             Write-Error "Expected files do not exist"
@@ -111,4 +110,213 @@ jobs:
         }
       shell: pwsh
 
-      
+    # Test glob downloading both artifacts to same directory
+    - name: Download all Artifacts
+      uses: ./
+      with:
+        pattern: Artifact-*
+        path: single/directory
+        merge-multiple: true
+
+    - name: Verify successful download
+      run: |
+        $fileA = "single/directory/file-A.txt"
+        $fileB = "single/directory/file-B.txt"
+        if(!(Test-Path -path $fileA) -or !(Test-Path -path $fileB))
+        {
+            Write-Error "Expected files do not exist"
+        }
+        if(!((Get-Content $fileA) -ceq "Lorem ipsum dolor sit amet") -or !((Get-Content $fileB) -ceq "Hello world from file B"))
+        {
+            Write-Error "File contents of downloaded artifacts are incorrect"
+        }
+      shell: pwsh
+
+    # Test downloading artifact without decompressing (skip-decompress)
+    - name: Download artifact A without decompressing
+      uses: ./
+      with:
+        name: Artifact-A-${{ matrix.runs-on }}
+        path: skip-decompress-test
+        skip-decompress: true
+
+    - name: Verify skip-decompress download
+      run: |
+        $rawFile = "skip-decompress-test/Artifact-A-${{ matrix.runs-on }}.zip"
+        if(!(Test-Path -path $rawFile))
+        {
+            Write-Error "Expected raw artifact file does not exist at $rawFile"
+        }
+        $fileInfo = Get-Item $rawFile
+        if($fileInfo.Length -eq 0)
+        {
+            Write-Error "Downloaded artifact file is empty"
+        }
+        Write-Host "Successfully downloaded artifact without decompressing: $rawFile (size: $($fileInfo.Length) bytes)"
+      shell: pwsh
+
+    # Regression test for artifact filename vs content-type mismatch
+    # When an archived artifact has a name with a file extension that doesn't
+    # match the blob type (e.g. "report.txt" but blob is zip), the server
+    # should append .zip to the content-disposition filename.
+    - name: Create and upload archived artifact with misleading extension
+      shell: bash
+      run: |
+        mkdir -p path/to/extension-test
+        echo '{"key": "value"}' > path/to/extension-test/data.json
+    - uses: actions/upload-artifact@v4 # V4 is important here to ensure we're supporting older versions correctly
+      with:
+        name: report.txt-${{ matrix.runs-on }}.json
+        path: path/to/extension-test/data.json
+
+    - name: Download misleading-extension artifact without decompressing
+      uses: ./
+      with:
+        name: report.txt-${{ matrix.runs-on }}.json
+        path: ext-test/raw
+        skip-decompress: true
+
+    - name: Verify downloaded file has .zip extension appended
+      shell: bash
+      run: |
+        expected="ext-test/raw/report.txt-${{ matrix.runs-on }}.json.zip"
+        if [ -f "$expected" ]; then
+          echo "PASS: Downloaded file has .zip appended: $expected"
+        else
+          echo "FAIL: Expected $expected but got:"
+          ls -al ext-test/raw/
+          exit 1
+        fi
+
+    # Test uploading and downloading artifacts with CJK (Chinese, Japanese, Korean) characters
+    # Regression test: certain non-ASCII chars (e.g. U+571F 土) caused 400 errors from
+    # Azure Blob Storage due to encoding issues in the Content-Disposition / rscd parameter
+    - name: Create artifacts with CJK names
+      shell: bash
+      run: |
+        mkdir -p path/to/cjk-artifacts
+        # Chinese - 土 (U+571F) known to fail, 日 (U+65E5) known to work
+        echo "Content for 土" > "path/to/cjk-artifacts/file-土-${{ matrix.runs-on }}.txt"
+        echo "Content for 中文测试" > "path/to/cjk-artifacts/file-中文测试-${{ matrix.runs-on }}.txt"
+        # Japanese - katakana and kanji
+        echo "Content for テスト" > "path/to/cjk-artifacts/file-テスト-${{ matrix.runs-on }}.txt"
+        echo "Content for 東京タワー" > "path/to/cjk-artifacts/file-東京タワー-${{ matrix.runs-on }}.txt"
+        # Korean - Hangul
+        echo "Content for 테스트" > "path/to/cjk-artifacts/file-테스트-${{ matrix.runs-on }}.txt"
+        echo "Content for 서울시" > "path/to/cjk-artifacts/file-서울시-${{ matrix.runs-on }}.txt"
+
+    - name: Upload CJK artifact - Chinese 土
+      uses: actions/upload-artifact@v7
+      with:
+        path: path/to/cjk-artifacts/file-土-${{ matrix.runs-on }}.txt
+        archive: false
+
+    - name: Upload CJK artifact - Chinese 中文测试
+      uses: actions/upload-artifact@v7
+      with:
+        path: path/to/cjk-artifacts/file-中文测试-${{ matrix.runs-on }}.txt
+        archive: false
+
+    - name: Upload CJK artifact - Japanese テスト
+      uses: actions/upload-artifact@v7
+      with:
+        path: path/to/cjk-artifacts/file-テスト-${{ matrix.runs-on }}.txt
+        archive: false
+
+    - name: Upload CJK artifact - Japanese 東京タワー
+      uses: actions/upload-artifact@v7
+      with:
+        path: path/to/cjk-artifacts/file-東京タワー-${{ matrix.runs-on }}.txt
+        archive: false
+
+    - name: Upload CJK artifact - Korean 테스트
+      uses: actions/upload-artifact@v7
+      with:
+        path: path/to/cjk-artifacts/file-테스트-${{ matrix.runs-on }}.txt
+        archive: false
+
+    - name: Upload CJK artifact - Korean 서울시
+      uses: actions/upload-artifact@v7
+      with:
+        path: path/to/cjk-artifacts/file-서울시-${{ matrix.runs-on }}.txt
+        archive: false
+
+    - name: Download CJK artifact - Chinese 土
+      uses: ./
+      with:
+        name: file-土-${{ matrix.runs-on }}.txt
+        path: cjk-download/土
+
+    - name: Download CJK artifact - Chinese 中文测试
+      uses: ./
+      with:
+        name: file-中文测试-${{ matrix.runs-on }}.txt
+        path: cjk-download/中文测试
+
+    - name: Download CJK artifact - Japanese テスト
+      uses: ./
+      with:
+        name: file-テスト-${{ matrix.runs-on }}.txt
+        path: cjk-download/テスト
+
+    - name: Download CJK artifact - Japanese 東京タワー
+      uses: ./
+      with:
+        name: file-東京タワー-${{ matrix.runs-on }}.txt
+        path: cjk-download/東京タワー
+
+    - name: Download CJK artifact - Korean 테스트
+      uses: ./
+      with:
+        name: file-테스트-${{ matrix.runs-on }}.txt
+        path: cjk-download/테스트
+
+    - name: Download CJK artifact - Korean 서울시
+      uses: ./
+      with:
+        name: file-서울시-${{ matrix.runs-on }}.txt
+        path: cjk-download/서울시
+
+    - name: Verify CJK artifact downloads
+      shell: bash
+      run: |
+        set -e
+        fail=0
+
+        check_file() {
+          local file="$1"
+          local expected="$2"
+          if [ ! -f "$file" ]; then
+            echo "FAIL: Missing file: $file"
+            fail=1
+            return
+          fi
+          actual=$(cat "$file")
+          if [ "$actual" != "$expected" ]; then
+            echo "FAIL: Content mismatch in $file"
+            echo "  Expected: '$expected'"
+            echo "  Got:      '$actual'"
+            fail=1
+            return
+          fi
+          echo "PASS: $file"
+        }
+
+        echo "=== Chinese ==="
+        check_file "cjk-download/土/file-土-${{ matrix.runs-on }}.txt" "Content for 土"
+        check_file "cjk-download/中文测试/file-中文测试-${{ matrix.runs-on }}.txt" "Content for 中文测试"
+
+        echo "=== Japanese ==="
+        check_file "cjk-download/テスト/file-テスト-${{ matrix.runs-on }}.txt" "Content for テスト"
+        check_file "cjk-download/東京タワー/file-東京タワー-${{ matrix.runs-on }}.txt" "Content for 東京タワー"
+
+        echo "=== Korean ==="
+        check_file "cjk-download/테스트/file-테스트-${{ matrix.runs-on }}.txt" "Content for 테스트"
+        check_file "cjk-download/서울시/file-서울시-${{ matrix.runs-on }}.txt" "Content for 서울시"
+
+        if [ "$fail" -ne 0 ]; then
+          echo "Some CJK artifact checks failed"
+          ls -alR cjk-download/ || true
+          exit 1
+        fi
+        echo "All CJK artifact downloads verified successfully"

.gitignore

@@ -2,4 +2,6 @@
 node_modules/
 
 # Ignore js files that are transpiled from ts files in src/
-lib/
+lib/
+
+.DS_Store

.licensed.yml

@@ -9,7 +9,37 @@ allowed:
   - mit
   - cc0-1.0
   - unlicense
+  - 0bsd
+  - blueoak-1.0.0
+  - other
+  - none
+
+ignored:
+  npm:
+    - "buffers"
 
 reviewed:
   npm:
-  - fs.realpath
+  - fs.realpath
+  - "@actions/http-client"
+  - "@bufbuild/protobuf"
+  - "@pkgjs/parseargs"
+  - "@protobuf-ts/runtime"
+  - argparse
+  - chainsaw
+  - color-convert
+  - ieee754
+  - jackspeak
+  - lodash
+  - mdurl
+  - neo-async
+  - package-json-from-dist
+  - path-scurry
+  - readable-stream
+  - sax
+  - source-map
+  - string_decoder
+  - traverse
+  - tslib
+  - uglify-js
+  - wordwrap