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

Comparing version 1.0.8 to 1.1.0

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -11,15 +11,19 @@ ---
 ## Describe the bug
+
 <!-- Please provide a clear and concise description of what the bug is. -->
 
 ## Reproduction Steps
+
 <!-- Steps to reproduce the behavior. -->
 
 ## Logs
+
 <!-- Please provide your deployment logs. If the error message isn't revealing the problem please set ACTIONS_STEP_DEBUG to true in your repository's secrets menu and run the workflow again. -->
 
 ## Workflow
+
 <!-- Please provide a link or snippet of your workflow yml file. -->
 
 ## Additional Comments
+
 <!--Add any other context about the problem here. -->
-

CONTRIBUTING.md

@@ -12,3 +12,3 @@ # Contributing ✏️
 4. When making a pull request, highlight any areas that may cause a breaking change so the maintainer can update the version number accordingly on the GitHub marketplace and package registries.
-5. Make sure you've formatted and linted your code. You can do this by running `yarn format` and `yarn lint`.
+5. Make sure you've linted and formatted your code. You can do this by running `yarn lint` and `yarn lint:format`.
 6. Fix or add any tests where applicable. You can run `yarn test` to run the suite. As this action is small in scope it's important that a high level of test coverage is maintained. All tests are written using [Jest](https://jestjs.io/).
@@ -15,0 +15,0 @@ 7. As this package is written in [TypeScript](https://www.typescriptlang.org/) please ensure all typing is accurate and the action compiles correctly by running `yarn build`.

lib/constants.js

@@ -11,3 +11,3 @@ "use strict";
         ? (0, core_1.getInput)('template')
-        : `<a href="https://github.com/{{{ login }}}"><img src="https://github.com/{{{ login }}}.png" width="60px" alt="" /></a>`,
+        : `<a href="https://github.com/{{{ login }}}"><img src="https://github.com/{{{ login }}}.png" width="60px" alt="{{{ name }}}" /></a>`,
     minimum: !(0, util_1.isNullOrUndefined)((0, core_1.getInput)('minimum'))
@@ -14,0 +14,0 @@ ? parseInt((0, core_1.getInput)('minimum'))

lib/template.js

@@ -40,5 +40,5 @@ "use strict";
                 url
-              }
-              `
-                : `
+              }`
+                : ``}
+              
               ... on User {
@@ -49,4 +49,2 @@ name
               }
-            `}
-
             }
@@ -53,0 +51,0 @@ createdAt

package.json

@@ -5,3 +5,3 @@ {
   "author": "James Ives <[e-mail]> (https://jamesiv.es)",
-  "version": "1.0.8",
+  "version": "1.1.0",
   "license": "MIT",
@@ -14,4 +14,6 @@ "main": "lib/lib.js",
     "test": "jest",
-    "lint": "eslint src/**/*.ts __tests__/**/*.ts",
-    "lint:format": "prettier --write './**/*.{ts,js,json,yml,md}' './*.{ts,js,json,yml,md}'"
+    "lint": "eslint --fix .",
+    "lint:check": "eslint .",
+    "lint:format": "prettier --write .",
+    "lint:format:check": "prettier --check ."
   },
@@ -37,4 +39,4 @@ "repository": {
     "@actions/core": "1.6.0",
-    "@actions/io": "1.1.1",
-    "cross-fetch": "3.1.4",
+    "@actions/io": "1.1.2",
+    "cross-fetch": "3.1.5",
     "mustache": "4.2.0"
@@ -44,18 +46,18 @@ },
     "@types/async-retry": "1.4.3",
-    "@types/jest": "27.4.0",
+    "@types/jest": "27.4.1",
     "@types/mustache": "4.1.2",
-    "@types/node": "17.0.8",
-    "@typescript-eslint/eslint-plugin": "5.9.0",
-    "@typescript-eslint/parser": "5.9.0",
-    "eslint": "8.6.0",
-    "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-jest": "25.3.4",
+    "@types/node": "18.0.0",
+    "@typescript-eslint/eslint-plugin": "5.29.0",
+    "@typescript-eslint/parser": "5.20.0",
+    "eslint": "8.14.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-jest": "26.5.3",
     "eslint-plugin-prettier": "4.0.0",
-    "jest": "27.4.7",
-    "jest-circus": "27.4.6",
-    "nock": "13.2.1",
-    "prettier": "2.5.1",
-    "ts-jest": "27.1.2",
-    "typescript": "4.5.4"
+    "jest": "27.5.1",
+    "jest-circus": "27.5.1",
+    "nock": "13.2.4",
+    "prettier": "2.7.1",
+    "ts-jest": "27.1.4",
+    "typescript": "4.6.4"
   }
 }

README.md

@@ -32,7 +32,12 @@ <p align="center">
 </p>
+<p align="center">
+ Maintainence of this project is made possible by all the <a href="https://github.com/JamesIves/github-pages-deploy-action/graphs/contributors">contributors</a> and <a href="https://github.com/sponsors/JamesIves">sponsors</a>. If you'd like to sponsor this project and have your avatar or company logo appear below <a href="https://github.com/sponsors/JamesIves">click here</a>. 💖
+</p>
 
-<p align="center">You can find an example of this below:</p>
+<p align="center">
+<!-- real-premium --><a href="https://github.com/github"><img src="https://github.com/github.png" width="80px" alt="github" /></a>&nbsp;&nbsp;<!-- real-premium -->
+</p>
 
 <p align="center">
-<!-- real-sponsors --><a href="https://github.com/milanpollock"><img src="https://github.com/milanpollock.png" width="40px" alt="" /></a><a href="https://github.com/raoulvdberge"><img src="https://github.com/raoulvdberge.png" width="40px" alt="" /></a><!-- 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;<a href="https://github.com/Yousazoe"><img src="https://github.com/Yousazoe.png" width="50px" alt="Yousazoe" /></a>&nbsp;&nbsp;<!-- real-sponsors -->
 </p>
@@ -58,3 +63,3 @@
       - name: Generate Sponsors 💖
-        uses: JamesIves/github-sponsors-readme-action@v1.0.8
+        uses: JamesIves/github-sponsors-readme-action@v1
         with:
@@ -124,3 +129,3 @@ token: ${{ secrets.PAT }}
 | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | -------- |
-| `organization` | If you're displaying sponsorship information as an organization you should toggle this option to `true`. You also need to provide the action with an `org: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 `org:read` 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**   |
@@ -174,3 +179,3 @@ | `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**   |
       - name: Generate Sponsors 💖
-        uses: JamesIves/github-sponsors-readme-action@v1.0.8
+        uses: JamesIves/github-sponsors-readme-action@v1
         with:
@@ -226,3 +231,3 @@ token: ${{ secrets.PAT }}
       - name: Generate Sponsors 💖
-        uses: JamesIves/github-sponsors-readme-action@v1.0.8
+        uses: JamesIves/github-sponsors-readme-action@v1
         with:
@@ -236,3 +241,3 @@ token: ${{ secrets.PAT }}
       - name: Generate Sponsors 💖
-        uses: JamesIves/github-sponsors-readme-action@v1.0.8
+        uses: JamesIves/github-sponsors-readme-action@v1
         with:
@@ -269,9 +274,1 @@ token: ${{ secrets.PAT }}
 </details>
-
----
-
-## Support 💖
-
-This project would not be possible without all of our fantastic [contributors](https://github.com/JamesIves/github-sponsors-readme-action/graphs/contributors) and [sponsors](https://github.com/sponsors/JamesIves). If you'd like to support the maintenance and upkeep of this project you can [donate via GitHub Sponsors](https://github.com/sponsors/JamesIves).
-
-<!-- sponsors --><a href="https://github.com/milanpollock"><img src="https://github.com/milanpollock.png" width="50px" alt="" /></a><a href="https://github.com/raoulvdberge"><img src="https://github.com/raoulvdberge.png" width="50px" alt="" /></a><!-- sponsors -->

src/constants.ts

@@ -28,3 +28,3 @@ import {getInput} from '@actions/core'
     ? getInput('template')
-    : `<a href="https://github.com/{{{ login }}}"><img src="https://github.com/{{{ login }}}.png" width="60px" alt="" /></a>`,
+    : `<a href="https://github.com/{{{ login }}}"><img src="https://github.com/{{{ login }}}.png" width="60px" alt="{{{ name }}}" /></a>`,
   minimum: !isNullOrUndefined(getInput('minimum'))
@@ -31,0 +31,0 @@ ? parseInt(getInput('minimum'))

src/template.ts

@@ -44,5 +44,6 @@ import 'cross-fetch/polyfill'
                 url
+              }`
+                  : ``
               }
-              `
-                  : `
+              
               ... on User {
@@ -53,5 +54,2 @@ name
               }
-            `
-              }
-
             }
@@ -58,0 +56,0 @@ createdAt

No alert changes

Improved metrics

Total package byte prevSize

187150

increased by0.43%

Number of package files

48

increased by2.13%

Worsened metrics

Lines of code

1560

decreased by-0.26%

Number of lines in readme file

268

decreased by-1.11%

Dependency changes

• + Added@actions/io@1.1.2(transitive)

• + Addedcross-fetch@3.1.5(transitive)

• + Addednode-fetch@2.6.7(transitive)

• + Addedtr46@0.0.3(transitive)

• + Addedwebidl-conversions@3.0.1(transitive)

• + Addedwhatwg-url@5.0.0(transitive)

• - Removed@actions/io@1.1.1(transitive)

• - Removedcross-fetch@3.1.4(transitive)

• - Removednode-fetch@2.6.1(transitive)

• Updated@actions/io@1.1.2

• Updatedcross-fetch@3.1.5