feat: removes github-token need

simonecorsi · May 11, 2022 · 0dc2a51 · 0dc2a51
1 parent 90a2e06
commit 0dc2a51
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -28,14 +28,13 @@ You can see an example of the output at my own [simonecorsi/awesome](https://git
 
 The service can be configured setting the appropriate environment variables or writing an `.env` file.
 
-| Variable          | Description                                              | Default                          |
-| ----------------- | -------------------------------------------------------- | -------------------------------- |
-| `api-token`       | Personal github api token.                               | `${{ secrets.API_TOKEN }}`       |
-| `github-token`    | This is the default github token used to commit and push | `${{ secrets.GITHUB_TOKEN }}`    |
-| `github-name`     | Name used for the commit                                 | Github Action                    |
-| `github-email`    | email used for commit                                    | actions@users.noreply.github.com |
-| `template-path`   | Custom `README.md` template, [read more](#template-path) |
-| `output-filename` | Output filename                                          | `README.md`                      |
+| Variable          | Description                                                         | Default                          |
+| ----------------- | ------------------------------------------------------------------- | -------------------------------- |
+| `api-token`       | Personal Token is used to avoid rate limit, [read more](#api-token) | `${{ secrets.API_TOKEN }}`       |
+| `github-name`     | Name used for the commit                                            | Github Action                    |
+| `github-email`    | email used for commit                                               | actions@users.noreply.github.com |
+| `template-path`   | Custom `README.md` template, [read more](#template-path)            |
+| `output-filename` | Output filename                                                     | `README.md`                      |
 
 #### `api-token`
 

diff --git a/action.yml b/action.yml
@@ -4,9 +4,6 @@ branding:
   icon: align-justify
   color: yellow
 inputs:
-  github-token:
-    description: 'Github token'
-    required: true
   api-token:
     description: 'Personal API Token'
     required: true

diff --git a/src/git.ts b/src/git.ts
@@ -15,7 +15,7 @@ type File = {
 
 class Git {
   constructor() {
-    const githubToken = core.getInput('github-token', { required: true });
+    const githubToken = core.getInput('api-token', { required: true });
     core.setSecret(githubToken);
 
     const githubName = core.getInput('github-name') || 'GitHub Actions';