doc(example): show env.GITHUB_TOKEN usage

Author: jimschubert

.github/workflows/community.yml

@@ -19,16 +19,19 @@ on:
   pull_request:
     types: [opened]
 
+permissions:
+  issues: write
+  pull-requests: write
+
 jobs:
 
   labeler:
     runs-on: ubuntu-latest
-
     steps:
     - name: Check Labels
       id: labeler
       uses: jimschubert/labeler-action@v2
       # uses: docker://jimschubert/test-labeler:action-0.0.0
       # uses: ./
-      with:
+      env:
         GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

README.md

@@ -8,7 +8,15 @@
 
 GitHub Action allowing for applying labels to issues and pull requests based on patterns found in the title or description.
 
-**NOTE** Thanks to the awesome efforts from the people at GitHub, `v2` and later support labeling from forked repositories via the [pull_request_target](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target) event.
+## Deprecation Notice
+
+⚠️ **The `GITHUB_TOKEN` input is deprecated and will be removed in v3.** Pass the token via `env` instead:
+
+```yaml
+- uses: jimschubert/labeler-action@v2
+  env:
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
 
 ## Usage
 
@@ -102,7 +110,7 @@ labels:
 
 ### Create a Workflow
 
-The action requires a single input parameter: `GITHUB_TOKEN`. This token allows the action to access the GitHub API for your account. Workflows automatically provide a default `GITHUB_TOKEN`, which provides full API access. You create a secret from a [new token](https://github.com/settings/tokens) with `public_repo` scope to limit the action's footprint.
+The action requires the `GITHUB_TOKEN` environment variable. This token allows the action to access the GitHub API for your account. Workflows automatically provide a default `GITHUB_TOKEN`, which provides full API access. You can create a secret from a [new token](https://github.com/settings/tokens) with `public_repo` scope to limit the action's footprint.
 
 **NOTE** Binding to issue or pull_request `edit` actions is _not_ recommended.
 
@@ -116,6 +124,10 @@ on:
   pull_request_target:
     types: [opened]
 
+permissions:
+  issues: write
+  pull-requests: write
+
 jobs:
 
   labeler:
@@ -125,7 +137,7 @@ jobs:
     - name: Check Labels
       id: labeler
       uses: jimschubert/labeler-action@v2
-      with:
+      env:
         GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 ```
 

main.go

@@ -41,7 +41,7 @@ func runLabelerFromEnv() error {
 			return fmt.Errorf("missing environment variable 'GITHUB_TOKEN' in labeler action configuration")
 		}
 	} else {
-		fmt.Println("::warning::The GITHUB_TOKEN input is deprecated. Pass it via env instead. See docs for details.")
+		fmt.Println("::warning::The GITHUB_TOKEN input is deprecated and will be removed in v3. Pass it via env instead. See docs for details.")
 	}
 
 	// actions will pass input GITHUB_TOKEN as env INPUT_GITHUB_TOKEN, so set this back to GITHUB_TOKEN for the lib.

main_test.go

@@ -149,3 +149,36 @@ func TestRunLabeler_InvokesLabelerError(t *testing.T) {
 		})
 	})
 }
+
+func TestRunLabeler_DeprecationWarning(t *testing.T) {
+	// Capture stdout to verify deprecation warning
+	oldStdout := os.Stdout
+	r, w, _ := os.Pipe()
+	os.Stdout = w
+
+	// INPUT_GITHUB_TOKEN simulates passing token via 'with:' in actions
+	withEnv("INPUT_GITHUB_TOKEN", "token", func() {
+		withEnv("GITHUB_EVENT_NAME", "issues", func() {
+			withEnv("GITHUB_EVENT_PATH", "testdata/issue.json", func() {
+				withEnv("GITHUB_REPOSITORY", "jimschubert/testrepo", func() {
+					withEnv("GITHUB_REPOSITORY_OWNER", "jimschubert", func() {
+						withMockLabeler(func(mockLabeler *MockLabeler) {
+							err := runLabelerFromEnv()
+							assert.NoError(t, err)
+						})
+					})
+				})
+			})
+		})
+	})
+
+	w.Close()
+	os.Stdout = oldStdout
+
+	var buf [1024]byte
+	n, _ := r.Read(buf[:])
+	output := string(buf[:n])
+
+	assert.Contains(t, output, "::warning::The GITHUB_TOKEN input is deprecated and will be removed in v3. Pass it via env instead. See docs for details.")
+}
+