fix: expose input field for the GitHub Token (#6)

BoringExperiments · Dec 1, 2023 · c4ba22d · c4ba22d
1 parent 6b39e39
commit c4ba22d
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 41 deletions.
diff --git a/README.md b/README.md
@@ -18,30 +18,29 @@ Before you start, make sure that you have setup the supported version of Python
 | =<3.6          | ❌ Not Supported |
 
 ```yml
-  - name: Set up Python 3.12
-    uses: actions/setup-python@v4
-    with:
-      python-version: 3.12
+- name: Set up Python 3.12
+  uses: actions/setup-python@v4
+  with:
+    python-version: 3.12
 ```
 
-| Input                  | Required                            | Description        |
-| ---------------------- | ----------------------------------- | ------------------ |
-| `source_dir`           | ✅ Yes                              | Input directory    |
-| `destination_dir`      | ❌ No (default to `source_dir`)     | Output directory   |
-| `signing_key`          | ❌ No                               | Signing key        |
-| `commit_message`       | ❌ No (default to `JSON Cleanup`)   | Commit message     |
-| `secrets.GITHUB_TOKEN` | ❌ No (default to GitHub's default) | GitHub's PAT token |
+| Input             | Required                          | Description                    |
+| ----------------- | --------------------------------- | ------------------------------ |
+| `token`           | ✅ Yes                            | GitHub's Personal Access Token |
+| `source_dir`      | ✅ Yes                            | Input directory                |
+| `destination_dir` | ❌ No (default to `source_dir`)   | Output directory               |
+| `signing_key`     | ❌ No                             | Signing key                    |
+| `commit_message`  | ❌ No (default to `JSON Cleanup`) | Commit message                 |
 
 ```yml
-  - name: Nested JSON Postprocessor
-    uses: validcube/[email protected]
-    with:
-      source_dir: 'path/to/your/source/directory'               # required, your input directory
-      destination_dir: 'path/to/your/destination/directory'     # optional, default to source_dir
-      signing_key: 'your-signing-key'                           # optional, will skip signing if not provided
-      commit_message: 'your-custom-commit-message'              # optional, default to "JSON Cleanup"
-    secrets:
-      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}                 # optional, default to GitHub's default
+- name: Nested JSON Postprocessor
+  uses: validcube/[email protected]
+  with:
+    token: ${{ secrets.GITHUB_TOKEN }} # required, GitHub's Personal Access Token
+    source_dir: "path/to/your/source/directory" # required, your input directory
+    destination_dir: "path/to/your/destination/directory" # optional, default to source_dir
+    signing_key: "your-signing-key" # optional, will skip signing if not provided
+    commit_message: "your-custom-commit-message" # optional, default to "JSON Cleanup"
 ```
 
 ## `> Postprocessor // Contributing`

diff --git a/README_ACTION.md b/README_ACTION.md
@@ -18,28 +18,27 @@ Before you start, make sure that you have setup the supported version of Python
 | =<3.6          | ❌ Not Supported |
 
 ```yml
-  - name: Set up Python 3.12
-    uses: actions/setup-python@v4
-    with:
-      python-version: 3.12
+- name: Set up Python 3.12
+  uses: actions/setup-python@v4
+  with:
+    python-version: 3.12
 ```
 
-| Input                  | Required                            | Description        |
-| ---------------------- | ----------------------------------- | ------------------ |
-| `source_dir`           | ✅ Yes                              | Input directory    |
-| `destination_dir`      | ❌ No (default to `source_dir`)     | Output directory   |
-| `signing_key`          | ❌ No                               | Signing key        |
-| `commit_message`       | ❌ No (default to `JSON Cleanup`)   | Commit message     |
-| `secrets.GITHUB_TOKEN` | ❌ No (default to GitHub's default) | GitHub's PAT token |
+| Input             | Required                          | Description                    |
+| ----------------- | --------------------------------- | ------------------------------ |
+| `token`           | ✅ Yes                            | GitHub's Personal Access Token |
+| `source_dir`      | ✅ Yes                            | Input directory                |
+| `destination_dir` | ❌ No (default to `source_dir`)   | Output directory               |
+| `signing_key`     | ❌ No                             | Signing key                    |
+| `commit_message`  | ❌ No (default to `JSON Cleanup`) | Commit message                 |
 
 ```yml
-  - name: Nested JSON Postprocessor
-    uses: ./.github/actions/python-action ???? # Soon:tm:
-    with:
-      source_dir: 'path/to/your/source/directory'               # required, your input directory
-      destination_dir: 'path/to/your/destination/directory'     # optional, default to source_dir
-      signing_key: 'your-signing-key'                           # optional, will skip signing if not provided
-      commit_message: 'your-custom-commit-message'              # optional, default to "JSON Cleanup"
-    secrets:
-      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}                 # optional, default to GitHub's default
+- name: Nested JSON Postprocessor
+  uses: ./.github/actions/python-action ???? # Soon:tm:
+  with:
+    token: ${{ secrets.GITHUB_TOKEN }} # required, GitHub's Personal Access Token
+    source_dir: "path/to/your/source/directory" # required, your input directory
+    destination_dir: "path/to/your/destination/directory" # optional, default to source_dir
+    signing_key: "your-signing-key" # optional, will skip signing if not provided
+    commit_message: "your-custom-commit-message" # optional, default to "JSON Cleanup"
 ```
diff --git a/action.yml b/action.yml
@@ -2,6 +2,9 @@ name: "Crowdin Nested JSON Postprocessor"
 description: "Runs a Python script that remove empty string in JSON caused by Crowdin not respecting skip untranslated strings"
 
 inputs:
+  token:
+    description: "GitHub's Personal Access Token"
+    required: true
   source_dir:
     description: "The source directory to copy"
     required: true
@@ -49,7 +52,7 @@ runs:
         else
           COMMIT_OPTIONS=""
         fi
-        echo "${{ secrets.GITHUB_TOKEN }}" | gh auth login --with-token
+        echo "${{ inputs.token }}" | gh auth login --with-token
         git add .
         git commit $COMMIT_OPTIONS -m ${{ inputs.commit_message }}
         git push