Merge f80349a6ad into 85e6279cec

Adjust positioning of user email note and permissions heading (#2044 )
Documentation update - add recommended permissions to Readme (#2043 )
2025-09-06 21:52:19 +08:00 · 2025-02-01 11:08:31 +00:00 · 2025-01-16 15:56:18 -05:00 · 2025-01-16 14:14:48 -05:00 · 2022-09-02 14:11:12 +02:00 · 2020-10-02 17:20:12 +02:00
7 changed files with 82 additions and 41 deletions
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -29,6 +29,8 @@ jobs:
        run: __test__/verify-no-unstaged-changes.sh

  test:
+    env:
+      main_path: main_path_test
    strategy:
      matrix:
        runs-on: [ubuntu-latest, macos-latest, windows-latest]
@@ -62,6 +64,16 @@ jobs:
        shell: bash
        run: __test__/verify-clean.sh

+      # Use environment variable as path
+      - name: Environment path test
+        uses: ./
+        with:
+          ref: test-data/v2/basic
+          path: ${{ env.main_path }}
+      - name: Verify environment path test
+        shell: bash
+        run: __test__/verify-environment-path.sh
+
      # Side by side
      - name: Checkout side by side 1
        uses: ./
--- a/README.md
+++ b/README.md
@@ -71,7 +71,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
    # Default: true
    persist-credentials: ''

-    # Relative path under $GITHUB_WORKSPACE to place the repository
+    # Relative or absolute path under $GITHUB_WORKSPACE to place the repository
    path: ''

    # Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching
@@ -214,6 +214,18 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
 ```
 > - If your secondary repository is private or internal you will need to add the option noted in [Checkout multiple repos (private)](#Checkout-multiple-repos-private)

+## Checkout repo with a environment based path
+
+```yaml
+env:
+  main_path: ${{ github.workspace }}/main
+steps:
+- name: Checkout
+  uses: actions/checkout@v2
+  with:
+    path: ${{ env.main_path }}
+```
+
 ## Checkout multiple repos (nested)

 ```yaml
@@ -311,8 +323,17 @@ jobs:
          git commit -m "generated"
          git push
 ```
+
 *NOTE:* The user email is `{user.id}+{user.login}@users.noreply.github.com`. See users API: https://api.github.com/users/github-actions%5Bbot%5D

+# Recommended permissions
+
+When using the `checkout` action in your GitHub Actions workflow, it is recommended to set the following `GITHUB_TOKEN` permissions to ensure proper functionality, unless alternative auth is provided via the `token` or `ssh-key` inputs:
+
+```yaml
+permissions:
+  contents: read
+```

 # License

--- a/test/verify-environment-path.sh
+++ b/test/verify-environment-path.sh
@@ -0,0 +1,6 @@
+#!/bin/bash
+
+if [ ! -f "./main_path_test/basic-file.txt" ]; then
+    echo "Expected file does not exist"
+    exit 1
+fi
--- a/action.yml
+++ b/action.yml
@@ -53,7 +53,7 @@ inputs:
    description: 'Whether to configure the token or SSH key with the local git config'
    default: true
  path:
-    description: 'Relative path under $GITHUB_WORKSPACE to place the repository'
+    description: 'Relative or absolute path under $GITHUB_WORKSPACE to place the repository'
  clean:
    description: 'Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching'
    default: true
--- a/adrs/0153-checkout-v2.md
+++ b/adrs/0153-checkout-v2.md
@@ -65,7 +65,7 @@ We want to take this opportunity to make behavioral changes, from v1. This docum
    description: 'Whether to configure the token or SSH key with the local git config'
    default: true
  path:
-    description: 'Relative path under $GITHUB_WORKSPACE to place the repository'
+    description: 'Relative or absolute path under $GITHUB_WORKSPACE to place the repository'
  clean:
    description: 'Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching'
    default: true
--- a/package-lock.json
+++ b/package-lock.json
@@ -9,7 +9,7 @@
      "version": "4.2.2",
      "license": "MIT",
      "dependencies": {
-        "@actions/core": "^1.11.1",
+        "@actions/core": "^1.10.1",
        "@actions/exec": "^1.1.1",
        "@actions/github": "^6.0.0",
        "@actions/io": "^1.1.3",
@@ -17,21 +17,21 @@
        "uuid": "^9.0.1"
      },
      "devDependencies": {
-        "@types/jest": "^29.5.14",
+        "@types/jest": "^29.5.12",
        "@types/node": "^20.12.12",
        "@types/uuid": "^9.0.8",
        "@typescript-eslint/eslint-plugin": "^7.9.0",
        "@typescript-eslint/parser": "^7.9.0",
-        "@vercel/ncc": "^0.38.3",
+        "@vercel/ncc": "^0.38.1",
        "eslint": "^8.57.0",
        "eslint-plugin-github": "^4.10.2",
-        "eslint-plugin-jest": "^28.9.0",
+        "eslint-plugin-jest": "^28.8.2",
        "jest": "^29.7.0",
        "jest-circus": "^29.7.0",
        "js-yaml": "^4.1.0",
-        "prettier": "^3.4.1",
+        "prettier": "^3.3.3",
        "ts-jest": "^29.2.5",
-        "typescript": "^5.7.2"
+        "typescript": "^5.5.4"
      }
    },
    "node_modules/@aashutoshrathi/word-wrap": {
@@ -44,13 +44,20 @@
      }
    },
    "node_modules/@actions/core": {
-      "version": "1.11.1",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.11.1.tgz",
-      "integrity": "sha512-hXJCSrkwfA46Vd9Z3q4cpEpHB1rL5NG04+/rbqW9d3+CSvtB1tYe8UTpAlixa1vj0m/ULglfEK2UKxMGxCxv5A==",
-      "license": "MIT",
+      "version": "1.10.1",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.1.tgz",
+      "integrity": "sha512-3lBR9EDAY+iYIpTnTIXmWcNbX3T2kCkAEQGIQx4NVQ0575nk2k3GRZDTPQG+vVtS2izSLmINlxXf0uLtnrTP+g==",
      "dependencies": {
-        "@actions/exec": "^1.1.1",
-        "@actions/http-client": "^2.0.1"
+        "@actions/http-client": "^2.0.1",
+        "uuid": "^8.3.2"
+      }
+    },
+    "node_modules/@actions/core/node_modules/uuid": {
+      "version": "8.3.2",
+      "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
+      "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==",
+      "bin": {
+        "uuid": "dist/bin/uuid"
      }
    },
    "node_modules/@actions/exec": {
@@ -1565,11 +1572,10 @@
      }
    },
    "node_modules/@types/jest": {
-      "version": "29.5.14",
-      "resolved": "https://registry.npmjs.org/@types/jest/-/jest-29.5.14.tgz",
-      "integrity": "sha512-ZN+4sdnLUbo8EVvVc2ao0GFW6oVrQRPn4K2lglySj7APvSrgzxHiNNK99us4WDMi57xxA2yggblIAMNhXOotLQ==",
+      "version": "29.5.12",
+      "resolved": "https://registry.npmjs.org/@types/jest/-/jest-29.5.12.tgz",
+      "integrity": "sha512-eDC8bTvT/QhYdxJAulQikueigY5AsdBRH2yDKW3yveW7svY3+DzN84/2NUgkw10RTiJbWqZrTtoGVdYlvFJdLw==",
      "dev": true,
-      "license": "MIT",
      "dependencies": {
        "expect": "^29.0.0",
        "pretty-format": "^29.0.0"
@@ -1821,11 +1827,10 @@
      "dev": true
    },
    "node_modules/@vercel/ncc": {
-      "version": "0.38.3",
-      "resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.38.3.tgz",
-      "integrity": "sha512-rnK6hJBS6mwc+Bkab+PGPs9OiS0i/3kdTO+CkI8V0/VrW3vmz7O2Pxjw/owOlmo6PKEIxRSeZKv/kuL9itnpYA==",
+      "version": "0.38.1",
+      "resolved": "https://registry.npmjs.org/@vercel/ncc/-/ncc-0.38.1.tgz",
+      "integrity": "sha512-IBBb+iI2NLu4VQn3Vwldyi2QwaXt5+hTyh58ggAMoCGE6DJmPvwL3KPBWcJl1m9LYPChBLE980Jw+CS4Wokqxw==",
      "dev": true,
-      "license": "MIT",
      "bin": {
        "ncc": "dist/ncc/cli.js"
      }
@@ -3213,11 +3218,10 @@
      }
    },
    "node_modules/eslint-plugin-jest": {
-      "version": "28.9.0",
-      "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-28.9.0.tgz",
-      "integrity": "sha512-rLu1s1Wf96TgUUxSw6loVIkNtUjq1Re7A9QdCCHSohnvXEBAjuL420h0T/fMmkQlNsQP2GhQzEUpYHPfxBkvYQ==",
+      "version": "28.8.2",
+      "resolved": "https://registry.npmjs.org/eslint-plugin-jest/-/eslint-plugin-jest-28.8.2.tgz",
+      "integrity": "sha512-mC3OyklHmS5i7wYU1rGId9EnxRI8TVlnFG56AE+8U9iRy6zwaNygZR+DsdZuCL0gRG0wVeyzq+uWcPt6yJrrMA==",
      "dev": true,
-      "license": "MIT",
      "dependencies": {
        "@typescript-eslint/utils": "^6.0.0 || ^7.0.0 || ^8.0.0"
      },
@@ -5974,11 +5978,10 @@
      }
    },
    "node_modules/prettier": {
-      "version": "3.4.1",
-      "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.4.1.tgz",
-      "integrity": "sha512-G+YdqtITVZmOJje6QkXQWzl3fSfMxFwm1tjTyo9exhkmWSqC4Yhd1+lug++IlR2mvRVAxEDDWYkQdeSztajqgg==",
+      "version": "3.3.3",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.3.3.tgz",
+      "integrity": "sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew==",
      "dev": true,
-      "license": "MIT",
      "bin": {
        "prettier": "bin/prettier.cjs"
      },
@@ -6899,11 +6902,10 @@
      }
    },
    "node_modules/typescript": {
-      "version": "5.7.2",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.7.2.tgz",
-      "integrity": "sha512-i5t66RHxDvVN40HfDd1PsEThGNnlMCMT3jMUuoh9/0TaqWevNontacunWyN02LA9/fIbEWlcHZcgTKb9QoaLfg==",
+      "version": "5.5.4",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.5.4.tgz",
+      "integrity": "sha512-Mtq29sKDAEYP7aljRgtPOpTvOfbwRWlS6dPRzwjdE+C0R4brX/GUyhHSecbHMFLNBLcJIPt9nl9yG5TZ1weH+Q==",
      "dev": true,
-      "license": "Apache-2.0",
      "bin": {
        "tsc": "bin/tsc",
        "tsserver": "bin/tsserver"
--- a/package.json
+++ b/package.json
@@ -28,7 +28,7 @@
  },
  "homepage": "https://github.com/actions/checkout#readme",
  "dependencies": {
-    "@actions/core": "^1.11.1",
+    "@actions/core": "^1.10.1",
    "@actions/exec": "^1.1.1",
    "@actions/github": "^6.0.0",
    "@actions/io": "^1.1.3",
@@ -36,20 +36,20 @@
    "uuid": "^9.0.1"
  },
  "devDependencies": {
-    "@types/jest": "^29.5.14",
+    "@types/jest": "^29.5.12",
    "@types/node": "^20.12.12",
    "@types/uuid": "^9.0.8",
    "@typescript-eslint/eslint-plugin": "^7.9.0",
    "@typescript-eslint/parser": "^7.9.0",
-    "@vercel/ncc": "^0.38.3",
+    "@vercel/ncc": "^0.38.1",
    "eslint": "^8.57.0",
    "eslint-plugin-github": "^4.10.2",
-    "eslint-plugin-jest": "^28.9.0",
+    "eslint-plugin-jest": "^28.8.2",
    "jest": "^29.7.0",
    "jest-circus": "^29.7.0",
    "js-yaml": "^4.1.0",
-    "prettier": "^3.4.1",
+    "prettier": "^3.3.3",
    "ts-jest": "^29.2.5",
-    "typescript": "^5.7.2"
+    "typescript": "^5.5.4"
  }
 }
Author	SHA1	Message	Date
Johnny Willemsen	c7da236801	Merge `f80349a6ad` into `85e6279cec`	2025-02-01 11:08:31 +00:00
Josh Gross	85e6279cec	Adjust positioning of user email note and permissions heading (#2044 ) Some checks failed CodeQL / Analyze (javascript) (push) Has been cancelled Details Build and Test / build (push) Has been cancelled Details Build and Test / test (macos-latest) (push) Has been cancelled Details Build and Test / test (ubuntu-latest) (push) Has been cancelled Details Build and Test / test (windows-latest) (push) Has been cancelled Details Build and Test / test-proxy (push) Has been cancelled Details Build and Test / test-bypass-proxy (push) Has been cancelled Details Build and Test / test-git-container (push) Has been cancelled Details Build and Test / test-output (push) Has been cancelled Details	2025-01-16 15:56:18 -05:00
Ben Wells	009b9ae9e4	Documentation update - add recommended permissions to Readme (#2043 ) * Update README.md * Update README.md Co-authored-by: Josh Gross <joshmgross@github.com> --------- Co-authored-by: Josh Gross <joshmgross@github.com>	2025-01-16 14:14:48 -05:00
Johnny Willemsen	f80349a6ad	Merge branch 'actions:main' into jwi-pathdocu	2022-09-02 14:11:12 +02:00
Johnny Willemsen	8af5cbfde0	Merge branch 'main' into jwi-pathdocu	2020-10-02 17:20:12 +02:00
Johnny Willemsen	d795c2780e	Move env to test step * .github/workflows/test.yml:	2020-08-26 12:44:28 +02:00
Johnny Willemsen	d345e1892f	Back to basic * .github/workflows/test.yml:	2020-08-26 12:26:01 +02:00
Johnny Willemsen	388793bd97	Use ref as it should * .github/workflows/test.yml:	2020-08-26 12:25:15 +02:00
Johnny Willemsen	4f92610a97	Added environment based path test * __test__/verify-environment-path.sh: Added. * .github/workflows/test.yml:	2020-08-26 12:18:55 +02:00
Johnny Willemsen	e67ad3383b	Removed side by side * README.md:	2020-08-26 12:11:07 +02:00
Johnny Willemsen	146dd77449	The path can be relative or absolute under $GITHUB_WORKSPACE * README.md: * action.yml: * adrs/0153-checkout-v2.md:	2020-08-26 12:09:04 +02:00