Updated to also run on Linux as well as documented for use on Pipelines

Author: ThomasArdal

.github/workflows/blank.yml

@@ -13,22 +13,22 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Patch vss-extension.json
         uses: onlyutkarsh/[email protected]
         with:
           files: vss-extension.json
-          patch-syntax: = /version => "3.1.${{ github.run_number }}"
+          patch-syntax: = /version => "4.0.${{ github.run_number }}"
           fail-if-no-files-patched: true
 
       - name: Patch task.json
         uses: onlyutkarsh/[email protected]
         with:
           files: ElmahIoUploadSourceMap/task.json
           patch-syntax: |
-            = /version/Major => "3"
-            = /version/Minor => "1"
+            = /version/Major => "4"
+            = /version/Minor => "0"
             = /version/Patch => "${{ github.run_number }}"
           fail-if-no-files-patched: true
 
@@ -45,8 +45,8 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
         with:
-          tag_name: 3.1.${{ github.run_number }}
-          release_name: Release 3.1.${{ github.run_number }}
+          tag_name: 4.0.${{ github.run_number }}
+          release_name: Release 4.0.${{ github.run_number }}
           draft: false
 
       - name: Upload vsix
@@ -56,6 +56,6 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           upload_url: ${{ steps.create_release.outputs.upload_url }}
-          asset_path: ./elmahio.elmah-io-upload-source-map-3.1.${{ github.run_number }}.vsix
-          asset_name: elmahio.elmah-io-upload-source-map-3.1.${{ github.run_number }}.vsix
+          asset_path: ./elmahio.elmah-io-upload-source-map-4.0.${{ github.run_number }}.vsix
+          asset_name: elmahio.elmah-io-upload-source-map-4.0.${{ github.run_number }}.vsix
           asset_content_type: application/zip

ElmahIoUploadSourceMap/task.json

@@ -11,9 +11,9 @@
     ],
     "author": "elmah.io",
     "version": {
-        "Major": 3,
+        "Major": 4,
         "Minor": 0,
-        "Patch": 19
+        "Patch": 0
     },
     "demands": [],
     "minimumAgentVersion": "1.104.0",
@@ -58,7 +58,13 @@
     "instanceNameFormat": "elmah.io Upload Source Map for $(path)",
     "execution": {
         "PowerShell3": {
-            "target": "upload.ps1"
+            "target": "upload.ps1",
+            "platforms": [
+                "windows",
+                "linux",
+                "darwin"
+            ],
+            "pwsh": true
         }
     }
 }

README.md

@@ -4,16 +4,36 @@ This extension is able to upload a source map and a minified JavaScript file to
 
 ## Usage
 
-1. Go to the [elmah.io Upload Source Map](https://marketplace.visualstudio.com/items?itemName=elmahio.elmah-io-upload-source-map) extension on the Azure DevOps Marketplace and click the _Get it free_ button:
+Go to the [elmah.io Upload Source Map](https://marketplace.visualstudio.com/items?itemName=elmahio.elmah-io-upload-source-map) extension on the Azure DevOps Marketplace and click the _Get it free_ button:
 
 ![Install the extension](images/marketplace_get_it_free.png)
 
-2. Select your organization and click the *Install* button:
+Select your organization and click the *Install* button:
 
 ![Select organization](images/marketplace_select_organization.png)
 
-3. Go to your Azure DevOps project and add the *elmah.io Upload Source Map* task. Fill in all fields as shown here:
+The task supports both Pipelines and Releases. No matter which approach you choose, you will need to replace `API_KEY` with an API key ([Where is my API key?](https://docs.elmah.io/where-is-my-api-key/)) with permission ([How to configure API key permissions](https://docs.elmah.io/how-to-configure-api-key-permissions/)) to upload source maps. Replace `LOG_ID` with the ID ([Where is my log ID?](https://docs.elmah.io/where-is-my-log-id/)) of the log the source map belongs to. **Path** must contain the relative path to the minified JavaScript. **Source Map File** and **Minified JavaScript File** must contain a path to the generated source map and minified JavaScript file.
 
-![Add the task](images/release_pipeline_task.png)
+### Pipelines
 
-You will need to replace `API_KEY` with an API key ([Where is my API key?](https://docs.elmah.io/where-is-my-api-key/)) with permission ([How to configure API key permissions](https://docs.elmah.io/how-to-configure-api-key-permissions/)) to upload source maps and `LOG_ID` with the ID ([Where is my log ID?](https://docs.elmah.io/where-is-my-log-id/)) of the log the source map belongs to. **Path** must contain the relative path to the minified JavaScript. **Source Map File** and **Minified JavaScript File** must contain a path to the generated source map and minified JavaScript file.
+Go to your Azure DevOps Pipeline configuration and add the *elmah.io Upload Source Map* task. Fill in the fields as shown here:
+
+![Add the task](images/pipeline_task.png)
+
+When clicking the *Add* button, YAML code will be added to your configuration looking similar to this:
+
+```yaml
+- task: ElmahIoUploadSourceMap@4
+  inputs:
+    apiKey: 'API_KEY'
+    logId: 'LOG_ID'
+    path: '/bundles/sharedbundle.min.js'
+    sourceMap: '$(System.DefaultWorkingDirectory)/myproject/drop/bundles/sharedbundle.map'
+    minifiedJavaScript: '$(System.DefaultWorkingDirectory)/myproject/drop/bundles/sharedbundle.min.js'
+```
+
+### Releases
+
+Go to your Azure DevOps Release configuration and add the *elmah.io Upload Source Map* task. Fill in all fields as shown here:
+
+![Add the task](images/release_pipeline_task.png)

images/pipeline_task.png

@@ -2,7 +2,7 @@
     "manifestVersion": 1,
     "id": "elmah-io-upload-source-map",
     "name": "elmah.io Upload Source Map",
-    "version": "3.0.19",
+    "version": "4.0.0",
     "publisher": "elmahio",
     "tags": [
         "Error",
@@ -56,7 +56,7 @@
     },
     "description": "Tasks for uploading source maps to elmah.io from Azure DevOps.",
     "categories": [
-        "Azure Pipelines"
+        "Build and release"
     ],
     "icons": {
         "default": "extension-icon.png"