Merge remote-tracking branch 'origin/master' into kotewar/allow-http-client-for-cache-download

Add documentation for notice (#1105 )
* Add documentation for notice This is described in documentation elsewhere. * Update docs/commands.md Co-authored-by: Konrad Pabjan <[email protected]> Co-authored-by: Konrad Pabjan <[email protected]>
2023-02-10 06:19:41 +00:00 · 2023-01-11 14:09:01 -05:00 · 2022-12-27 17:57:58 +00:00 · 2022-12-07 15:09:30 +00:00 · 2022-11-17 12:42:10 +05:30 · 2022-11-17 12:26:27 +05:30
16 changed files with 1521 additions and 2711 deletions
@@ -22,12 +22,12 @@ jobs:

    steps:
    - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v2

-    - name: Set Node.js 16.x
-      uses: actions/setup-node@v3
+    - name: Set Node.js 12.x
+      uses: actions/setup-node@v1
      with:
-        node-version: 16.x
+        node-version: 12.x

    # In order to upload & download artifacts from a shell script, certain env variables need to be set that are only available in the
    # node context. This runs a local action that gets and sets the necessary env variables that are needed
@@ -58,13 +58,6 @@ jobs:
        echo ${{ env.non-gzip-artifact-content }} > artifact-path/world.txt
        echo ${{ env.gzip-artifact-content }} > artifact-path/gzip.txt
        touch artifact-path/empty.txt
-        
-    - name: Add additional logging after create
-      shell: bash
-      run: | 
-        cat ./artifact-path/world.txt
-        cat ./artifact-path/gzip.txt
-        cat ./artifact-path/empty.txt

    # We're using node -e to call the functions directly available in the @actions/artifact package
    - name: Upload artifacts using uploadArtifact()
@@ -81,14 +74,7 @@ jobs:
        node -e "Promise.resolve(require('./packages/artifact/lib/artifact-client').create().downloadArtifact('my-artifact-2','artifact-2-directory'))"
        mkdir artifact-3-directory
        node -e "Promise.resolve(require('./packages/artifact/lib/artifact-client').create().downloadArtifact('my-artifact-3','artifact-3-directory'))"
-    
-    - name: Add additional logging
-      shell: bash
-      run: | 
-        cat ./artifact-1-directory/artifact-path/world.txt
-        cat ./artifact-2-directory/artifact-path/gzip.txt
-        cat ./artifact-3-directory/artifact-path/empty.txt
-        
+
    - name: Verify downloadArtifact()
      shell: bash
      run: |
@@ -18,12 +18,12 @@ jobs:

    steps:
    - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v2

-    - name: Set Node.js 14.x
-      uses: actions/setup-node@v3
+    - name: Set Node.js 12.x
+      uses: actions/setup-node@v1
      with:
-        node-version: 14.x
+        node-version: 12.x

    - name: npm install
      run: npm install
@@ -22,12 +22,12 @@ jobs:

    steps:
    - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v2

-    - name: Set Node.js 14.x
-      uses: actions/setup-node@v3
+    - name: Set Node.js 12.x
+      uses: actions/setup-node@v1
      with:
-        node-version: 14.x
+        node-version: 12.x

    # In order to save & restore cache from a shell script, certain env variables need to be set that are only available in the
    # node context. This runs a local action that gets and sets the necessary env variables that are needed
@@ -20,7 +20,7 @@ jobs:

    steps:
    - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v2

    # Initializes the CodeQL tools for scanning.
    - name: Initialize CodeQL
@@ -13,15 +13,15 @@ jobs:

    steps:
      - name: setup repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v2

      - name: verify package exists
        run: ls packages/${{ github.event.inputs.package }}

-      - name: Set Node.js 14.x
-        uses: actions/setup-node@v3
+      - name: Set Node.js 12.x
+        uses: actions/setup-node@v1
        with:
-          node-version: 14.x
+          node-version: 12.x

      - name: npm install
        run: npm install
@@ -23,13 +23,12 @@ jobs:

    steps:
    - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v2

-    - name: Set Node.js 14.x
-      uses: actions/setup-node@v3
+    - name: Set Node.js 12.x
+      uses: actions/setup-node@v1
      with:
-        node-version: 14.x
-    - run: npm -v
+        node-version: 12.x

    - name: npm install
      run: npm install
@@ -9,7 +9,7 @@ jobs:
    if: ${{ github.repository_owner == 'actions' }}
    steps:
    - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v2
    - name: Update Octokit
      working-directory: packages/github 
      run: |
@@ -32,7 +32,7 @@ jobs:
        os: [ubuntu-16.04, windows-2019]
    runs-on: ${{matrix.os}}
    actions:
-    - uses: actions/setup-node@v3
+    - uses: actions/setup-node@v1
      with:
        version: ${{matrix.node}}
    - run: | 
@@ -17,7 +17,7 @@ Binding to a major version is the latest of that major version ( e.g. `v1` == "1

 Major versions should guarantee compatibility.  A major version can add net new capabilities but should not break existing input compatibility or break existing workflows. 

-Major version binding allows you to take advantage of bug fixes and critical functionality and security fixes.  The `main` branch has the latest code and is unstable to bind to since changes get committed to main and released to the market place by creating a tag.  In addition, a new major version carrying breaking changes will get implemented in main after branching off the previous major version.
+Major version binding allows you to take advantage of bug fixes and critical functionality and security fixes.  The `main` branch has the latest code and is unstable to bind to since changes get committed to `main` and released to the market place by creating a tag.  In addition, a new major version carrying breaking changes will get implemented in `main` after branching off the previous major version.

 > Warning: do not reference `main` since that is the latest code and can be carrying breaking changes of the next major version.

@@ -100,9 +100,12 @@ There are several commands to emit different levels of log output:
 | log level | example usage |
 |---|---|
 | [debug](action-debugging.md)  | `echo "::debug::My debug message"` |
+| notice | `echo "::notice::My notice message"` |
 | warning | `echo "::warning::My warning message"` |
 | error | `echo "::error::My error message"` |

+Additional syntax options are described at [the workflow command documentation](https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-a-debug-message).
+
 ### Command Echoing

 By default, the echoing of commands to stdout only occurs if [Step Debugging is enabled](./action-debugging.md#How-to-Access-Step-Debug-Logs)
@@ -18,7 +18,7 @@ e.g. To use https://github.com/actions/setup-node, users will author:

 ```yaml
 steps:
-    using: actions/setup-node@v3
+    using: actions/setup-node@v1
 ```

 # Define Metadata
@@ -47,3 +47,5 @@ const cacheKey = await cache.restoreCache(paths, key, restoreKeys)
 A cache gets downloaded in multiple segments of fixed sizes (`1GB` for a `32-bit` runner and `2GB` for a `64-bit` runner). Sometimes, a segment download gets stuck which causes the workflow job to be stuck forever and fail. Version `v3.0.4` of cache package introduces a segment download timeout. The segment download timeout will allow the segment download to get aborted and hence allow the job to proceed with a cache miss.

 Default value of this timeout is 60 minutes and can be customized by specifying an [environment variable](https://docs.github.com/en/actions/learn-github-actions/environment-variables) named `SEGMENT_DOWNLOAD_TIMEOUT_MINS` with timeout value in minutes.
+
+We are also introducing a new variable `DOWNLOAD_WITH_HTTP_CLIENT`, which if set to `true` downloads the cache using plain http-client and not Azure SDK. This has been introduced keeping in mind the problem Azure SDK is causing in downloads getting stuck infinitely.
@@ -457,9 +457,9 @@
      }
    },
    "node_modules/minimatch": {
-      "version": "3.1.2",
-      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
-      "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
+      "version": "3.0.4",
+      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
+      "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
      "dependencies": {
        "brace-expansion": "^1.1.7"
      },
@@ -998,9 +998,9 @@
      }
    },
    "minimatch": {
-      "version": "3.1.2",
-      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
-      "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
+      "version": "3.0.4",
+      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
+      "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
      "requires": {
        "brace-expansion": "^1.1.7"
      }
@@ -132,7 +132,7 @@ export async function downloadCache(

  if (
    downloadOptions.useAzureSdk &&
-    archiveUrl.hostname.endsWith('.blob.core.windows.net')
+    archiveUrl.hostname.endsWith('.blob.core.windows.net') && !process.env['DOWNLOAD_WITH_HTTP_CLIENT']
  ) {
    // Use Azure storage SDK to download caches hosted on Azure to improve speed and reliability.
    await downloadCacheStorageSDK(archiveLocation, archivePath, downloadOptions)
@@ -50,9 +50,9 @@
      "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s="
    },
    "node_modules/minimatch": {
-      "version": "3.1.2",
-      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
-      "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
+      "version": "3.0.4",
+      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
+      "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
      "dependencies": {
        "brace-expansion": "^1.1.7"
      },
@@ -115,9 +115,9 @@
      "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s="
    },
    "minimatch": {
-      "version": "3.1.2",
-      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz",
-      "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==",
+      "version": "3.0.4",
+      "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
+      "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
      "requires": {
        "brace-expansion": "^1.1.7"
      }
Author	SHA1	Message	Date
Sankalp KotewarandGitHub	d556ae3fc4	Merge remote-tracking branch 'origin/master' into kotewar/allow-http-client-for-cache-download	2023-02-10 06:19:41 +00:00
Eric Wieser GitHub Konrad Pabjan	74906bea83	Add documentation for notice (#1105 ) Code Scanning - Action / CodeQL-Build (push) Has been cancelled Details * Add documentation for notice This is described in documentation elsewhere. * Update docs/commands.md Co-authored-by: Konrad Pabjan <[email protected]> Co-authored-by: Konrad Pabjan <[email protected]>	2023-01-11 14:09:01 -05:00
Sankalp KotewarandGitHub	59d682457a	Merge remote-tracking branch 'origin/master' into kotewar/allow-http-client-for-cache-download	2022-12-27 17:57:58 +00:00
Sankalp KotewarandGitHub	a64055103d	Added env var for using Http client	2022-12-07 15:09:30 +00:00
Sampark SharmaandGitHub	819157bf87	Merge pull request #1238 from actions/revert-1232-phantsure/gnutar_windows Revert "Add GNUtar as default in windows"	2022-11-17 12:42:10 +05:30
Sampark SharmaandGitHub	86102e88e9	Revert "Add GNUtar as default in windows"	2022-11-17 12:26:27 +05:30
Sampark SharmaandGitHub	e4c071ba19	Merge pull request #1232 from actions/phantsure/gnutar_windows Add GNUtar as default in windows	2022-11-16 16:55:59 +05:30
Sampark SharmaandGitHub	9443e26349	Address review comments	2022-11-15 10:18:46 +00:00
Sampark SharmaandGitHub	5a0405df4e	Fix tests	2022-11-15 08:48:29 +00:00
Sampark SharmaandGitHub	0e707aeabc	Address comments	2022-11-15 08:41:04 +00:00
Sampark SharmaandGitHub	7441dc5e59	Fix tests	2022-11-14 10:25:17 +00:00
Sampark SharmaandGitHub	1ddac5e02f	Fix tests	2022-11-14 10:11:46 +00:00
Sampark SharmaandGitHub	55484166d8	Address review comments	2022-11-14 08:12:15 +00:00
Sampark SharmaandGitHub	7181b913f5	Remove export	2022-11-14 06:34:18 +00:00
Sampark SharmaandGitHub	81cd5a5c2e	Revert "Add logs for cache version on miss" This reverts commit `4b348086a9`.	2022-11-14 06:33:53 +00:00
Sampark SharmaandGitHub	4b348086a9	Add logs for cache version on miss	2022-11-14 05:24:09 +00:00
Sampark SharmaandGitHub	436cf8d6ea	Fix tests	2022-11-10 15:50:06 +00:00
Sampark SharmaandGitHub	e0aadb573c	Fix GNUtar path	2022-11-08 08:29:31 +00:00
Sampark SharmaandGitHub	62a66a8ce9	Fix tests	2022-11-08 06:43:28 +00:00
Sampark SharmaandGitHub	0c58e4113e	Fix gnutar check on windows	2022-11-07 13:43:54 +00:00
Sampark SharmaandGitHub	9366237c90	Add gnuTar as default in windows	2022-11-07 13:39:07 +00:00
Josh SorefandGitHub	2f164000dc	Fix debug logging link (#820 )	2021-05-25 14:28:45 -04:00
Federico GrandiandGitHub	dc8e290405	docs(README): fix minor formatting issue (#819 )	2021-05-24 10:23:40 -04:00
Linus UnnebäckandGitHub	e9c6ee99a5	Simplify mkdirP implementation (#444 )	2021-04-28 14:24:23 -04:00
madheadandGitHub	4bf916289e	master → main (#596 )	2021-02-19 10:02:58 -05:00