chore: Update GitHub Action configuration for dotnet-format on Pull R…

…equest

README.md

@@ -5,6 +5,29 @@ dotnet-format for GitHub Actions
 
 See [action.yml](action.yml)
 
+**Basic**:
+```yaml
+steps:
+  - uses: actions/checkout@v4
+  - uses: actions/setup-dotnet@v4
+    with:
+      dotnet-version: '8.0.x'
+  - uses: tsubakimoto/action-dotnet-format@v0
+    with:
+      base-branch: ${{ github.head_ref }}
+      project-path: 'example.csproj'
+      github-token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+### Permissions
+
+The `GITHUB_TOKEN` secret is required to create a pull request.
+
+| Permission | Value |
+| --- | --- |
+| `contents` | `write` |
+| `pull_requests` | `write` |
+
 ## License
 
 The scripts and documentation in this project are released under the [MIT License](LICENSE)

action.yml

@@ -16,6 +16,9 @@ inputs:
     description: 'Verbosity of the output'
     required: false
     default: 'normal'
+  github-token:
+    description: 'GitHub token'
+    required: true
 outputs:
   head-branch:
     description: 'Head branch to compare against'
@@ -53,7 +56,7 @@ runs:
         echo "head-branch-name: $HEAD_BRANCH"
         echo "head-branch-name=$HEAD_BRANCH" >> $GITHUB_OUTPUT
       env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        GITHUB_TOKEN: ${{ inputs.github-token }}
       shell: bash
     - name: Create a pull request
       id: pr
@@ -69,5 +72,5 @@ runs:
         echo "Successfully created pull request: $url"
         echo "url=$url" >> $GITHUB_OUTPUT
       env:
-        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        GH_TOKEN: ${{ inputs.github-token }}
       shell: bash