@jamesives/github-sponsors-readme-action - npm Package Compare versions

Comparing version 1.2.1 to 1.2.2

package.json

@@ -5,3 +5,3 @@ {
   "author": "James Ives <[e-mail]> (https://jamesiv.es)",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "license": "MIT",
@@ -46,9 +46,9 @@ "main": "lib/lib.js",
     "@types/mustache": "4.2.1",
-    "@types/node": "18.7.6",
-    "@typescript-eslint/eslint-plugin": "5.29.0",
-    "@typescript-eslint/parser": "5.20.0",
-    "eslint": "8.22.0",
+    "@types/node": "18.7.18",
+    "@typescript-eslint/eslint-plugin": "5.39.0",
+    "@typescript-eslint/parser": "5.36.2",
+    "eslint": "8.24.0",
     "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-jest": "26.5.3",
-    "eslint-plugin-prettier": "4.0.0",
+    "eslint-plugin-jest": "27.0.4",
+    "eslint-plugin-prettier": "4.2.1",
     "jest": "27.5.1",
@@ -59,4 +59,4 @@ "jest-circus": "27.5.1",
     "ts-jest": "27.1.4",
-    "typescript": "4.7.4"
+    "typescript": "4.8.4"
   }
 }

README.md

@@ -41,3 +41,3 @@ <p align="center">
 <p align="center">
-<!-- real-sponsors --><!-- real-sponsors -->
+<!-- real-sponsors --><a href="https://github.com/Chooksta69"><img src="https://github.com/Chooksta69.png" width="50px" alt="Chooksta69" /></a>&nbsp;&nbsp;<a href="https://github.com/robjtede"><img src="https://github.com/robjtede.png" width="50px" alt="robjtede" /></a>&nbsp;&nbsp;<a href="https://github.com/hadley"><img src="https://github.com/hadley.png" width="50px" alt="hadley" /></a>&nbsp;&nbsp;<a href="https://github.com/kevinchalet"><img src="https://github.com/kevinchalet.png" width="50px" alt="kevinchalet" /></a>&nbsp;&nbsp;<!-- real-sponsors -->
 </p>
@@ -47,10 +47,13 @@
 
-You can include the action in your workflow to trigger on any event that [GitHub Actions supports](https://help.github.com/en/articles/events-that-trigger-workflows). You'll need to provide the action with a **Personal Access Token (PAT)** scoped to `user:read` (or `org:read` depending on your needs), and the file to parse.
+You can include the action in your workflow to trigger on any event that [GitHub Actions supports](https://help.github.com/en/articles/events-that-trigger-workflows).
 
+> **Note**
+> You'll need to provide the action with a **Personal Access Token (PAT)** scoped to `read:user` and `read:org`. This action only applies the template within the workspace. You will need to combine it with a deployment action in order to commit it to your project. You can see a full example of this below.
+
 ```yml
 name: Generate Sponsors README
 on:
-  push:
-    branches:
-      - main
+  workflow_dispatch:
+  schedule:
+    - cron: 30 15 * * 0-6
 jobs:
@@ -120,6 +123,6 @@ deploy:
 
-| Key     | Value Information                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Type   | Required |
-| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | -------- |
-| `token` | You must provide the action with a Personal Access Token (PAT) with either the `user:read` or `org:read` permission scope and store it in the `secrets / with` menu **as a secret**. This should be generated from the account or organization that receives sponsorship, and depending on your use case you may need to provide additional scopes. [Learn more about creating and using encrypted secrets here](https://docs.github.com/en/actions/reference/encrypted-secrets). | `with` | **Yes**  |
-| `file`  | This should point to the file that you're generating, for example `README.md` or `path/to/CREDITS.md`. Defaults to `README.md` if no value is provided.                                                                                                                                                                                                                                                                                                                           | `with` | **Yes**  |
+| Key     | Value Information                                                                                                                                                                                                                                                                                                                                                                                                                                                           | Type   | Required |
+| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | -------- |
+| `token` | You must provide the action with a Personal Access Token (PAT) with the `read:user` and `read:org` permission scope and store it in the `secrets / with` menu **as a secret**. This should be generated from the account or organization that receives sponsorship, and depending on your use case you may need to provide additional scopes. [Learn more about creating and using encrypted secrets here](https://docs.github.com/en/actions/reference/encrypted-secrets). | `with` | **Yes**  |
+| `file`  | This should point to the file that you're generating, for example `README.md` or `path/to/CREDITS.md`. Defaults to `README.md` if no value is provided.                                                                                                                                                                                                                                                                                                                     | `with` | **Yes**  |
 
@@ -130,3 +133,3 @@ #### Optional Choices
 | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | -------- |
-| `organization` | If you're displaying sponsorship information as or for an organization you should toggle this option to `true`. You also need to provide the action with an `org:read` and `user:read` scoped PAT.                                                    | `with` | **No**   |
+| `organization` | If you're displaying sponsorship information as or for an organization you should toggle this option to `true`. You also need to provide the action with an `read:org` and `read:user` scoped PAT.                                                    | `with` | **No**   |
 | `minimum`      | Using this input you can set the minimum sponsorship threshold. For example setting this to `500` will only display sponsors who give of `$5 USD` and more. By default the action will display all of your sponsors.                                  | `with` | **No**   |
@@ -155,8 +158,8 @@ | `maximum`      | Using this input you can set the maximum sponsorship threshold. For example setting this to `500` will only display sponsors who give of `$5 USD` and less. By default the action will display all of your sponsors.                                  | `with` | **No**   |
 
-| Status       | Description                                                                                                                      |
-| ------------ | -------------------------------------------------------------------------------------------------------------------------------- |
-| `name`       | The users full name. This can sometimes be `null` if the user hasn't set one. This can be accessed using `{{{ name }}}`          |
-| `login`      | The users login, this can be accessed using `{{{ login }}}`                                                                      |
-| `url`        | The users GitHub profile url, this can be accessed using `{{{ url }}}`.                                                          |
-| `websiteUrl` | The users website url. This can sometimes be `null` if the user hasn't set one. this can be accessed using `{{{ websiteUrl }}}`. |
+| Status       | Description                                                                                                                                                                |
+| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `name`       | The users full name. This can sometimes be `null` if the user hasn't set one. This can be accessed using `{{{ name }}}`                                                    |
+| `login`      | The users login, this can be accessed using `{{{ login }}}`                                                                                                                |
+| `url`        | The users GitHub profile url, this can be accessed using `{{{ url }}}`.                                                                                                    |
+| `websiteUrl` | The users website url. This can sometimes be `null` if the user hasn't set one, if so this field will fall back to `url`. This can be accessed using `{{{ websiteUrl }}}`. |
 
@@ -163,0 +166,0 @@ You're able to use markdown or GitHub approved basic HTML. The default template can be found [here](./src/constants.ts#L28).

No alert changes

Improved metrics

Total package byte prevSize

192596

increased by0.44%

Number of lines in readme file

272

increased by1.12%

No dependency changes