JamesIves/github-sponsors-readme-action

📦 Build 🔧

• Migrate from Node.js 20 to Node.js 24 runtime

📦 Dependencies 🤖

• chore(deps): bump typescript-eslint from 8.18.0 to 8.18.1 in the typescript group by @dependabot[bot] in https://github.com/JamesIves/github-sponsors-readme-action/pull/887
• chore(deps-dev): bump the eslint group with 2 updates by @dependabot[bot] in https://github.com/JamesIves/github-sponsors-readme-action/pull/886
• chore(deps): bump the misc group across 1 directory with 5 updates by @dependabot[bot] in https://github.com/JamesIves/github-sponsors-readme-action/pull/895
• chore(deps): bump typescript-eslint from 8.19.0 to 8.19.1 in the typescript group by @dependabot[bot] in https://github.com/JamesIves/github-sponsors-readme-action/pull/897
• chore(deps-dev): bump the eslint group with 2 updates by @dependabot[bot] in https://github.com/JamesIves/github-sponsors-readme-action/pull/896
• chore(deps): bump the misc group with 2 updates by @dependabot[bot] in https://github.com/JamesIves/github-sponsors-readme-action/pull/898
• chore(deps): bump undici from 5.28.4 to 5.28.5 by @dependabot[bot] in https://github.com/JamesIves/github-sponsors-readme-action/pull/906
• chore(deps): bump the misc group across 1 directory with 14 updates by @dependabot[bot] in https://github.com/JamesIves/github-sponsors-readme-action/pull/926
• + 31 more

🐛 Bug Fixes 🐝

• fix: resolved an issue where sponsorship avatars in the default template would vanish after some time due to expiring access tokens. Special thanks to @K-vanc for tracking this down.
• Full Changelog: https://github.com/JamesIves/github-sponsors-readme-action/compare/v1...v1.5.6

✨ Features ✨

• feat: slight improvement to alt text in default template by @JamesIves in https://github.com/JamesIves/github-sponsors-readme-action/pull/885

📦 Dependencies 🤖

• chore(deps-dev): bump the eslint group with 2 updates by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/862
• chore(deps): bump typescript-eslint from 8.13.0 to 8.14.0 in the typescript group by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/863
• chore(deps): bump the misc group across 1 directory with 9 updates by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/874
• chore(deps): bump codecov/codecov-action from 4 to 5 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/865
• chore(deps): bump the misc group across 1 directory with 7 updates by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/878
• chore(deps): bump the misc group across 1 directory with 4 updates by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/880
• chore(deps-dev): bump @types/node from 22.10.1 to 22.10.2 in the misc group by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/881
• chore(deps): bump @eslint/js from 9.16.0 to 9.17.0 in the eslint group by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/883
• + 2 more

📦 Dependencies 🤖

• chore(deps): mass bump dependencies by @JamesIves in https://github.com/JamesIves/github-sponsors-readme-action/pull/861
• chore(deps): switch to using `.node-version` instead of `.nvmrc` for Node dependency management.
• chore(deps): updated node version to 22.11.0 for development
• Full Changelog: https://github.com/JamesIves/github-sponsors-readme-action/compare/v1...v1.5.4

🐛 Bug Fixes 🐝

• fix: resolved a number of small typos in the action debug statements

✨ New Features 🎉

• feat: ✨ Added a log line that shows how many sponsors the action was able to retrieve.

🐛 Bug Fixes 🐝

• fix: resolved an issue where the default config was not being applied to the non-action version of the project.
• Full Changelog: https://github.com/JamesIves/github-sponsors-readme-action/compare/v1...v1.5.1

✨ New Features 🎉

• feat: ✨ Adds ability to display anonymized private sponsors. Private sponsors will be displayed in the list, however any identifying information will be redacted. This can be useful if you want to display all sponsors, regardless of their privacy settings. To enable this feature, you can set `include-private` to `true` in your workflow.
• feat: ✨ Adds the ability to use `avatarUrl` in a sponsorship template. This is an exposed field from the GitHub API and typically matches `https://github.com/{username}.png` (unless `include-private` is set to `true` that is)
• ```yml
• name: Generate Sponsors 💖
• uses: JamesIves/github-sponsors-readme-action@v1
• with:
• token: ${{ secrets.PAT }}
• file: 'README.md'
• + 8 more

🐛 Bug Fixes 🐝

• fix: mark `includePrivate` as `false` in the GraphQL query to ensure that user privacy is always respected regardless of what `privacyLevel` returns with due to potential difference in API versions.

📦 Dependencies 🤖

• chore(deps): bump micromatch from 4.0.5 to 4.0.8 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/821
• Full Changelog: https://github.com/JamesIves/github-sponsors-readme-action/compare/v1...v1.4.5

🐛 Bug Fixes 🐝

• fix: null check privacyLevel by @JamesIves in https://github.com/JamesIves/github-sponsors-readme-action/pull/820
• Full Changelog: https://github.com/JamesIves/github-sponsors-readme-action/compare/v1...v1.4.4

🐛 Bug Fixes 🐝

• docs(README): update README example based on yesterdays security patch by @JamesIves in https://github.com/JamesIves/github-sponsors-readme-action/pull/803
• Full Changelog: https://github.com/JamesIves/github-sponsors-readme-action/compare/v1...v1.4.3

🔒 Security 🔒

• fix: 🔒 Resolves a markdown injection vulnerability. Special thanks to @Nicocha30 for spotting this. ❤️
• Full Changelog: https://github.com/JamesIves/github-sponsors-readme-action/compare/v1...v1.4.2

📦 Dependencies 🤖

• chore(deps): bump the eslint group with 4 updates by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/763
• chore(deps): bump braces from 3.0.2 to 3.0.3 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/775
• chore(deps): bump ws from 7.5.9 to 7.5.10 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/778
• Full Changelog: https://github.com/JamesIves/github-sponsors-readme-action/compare/v1...v1.4.1

📋 What's Changed

• feat: ✨ support active-only input by @JamesIves in https://github.com/JamesIves/github-sponsors-readme-action/pull/737 - This feature allows you to show sponsors regardless of their sponsorship status. This is useful in scenarios where you want to show all sponsors who have previously donated, and not just those who hold an active subscription. To use this, you can set `active-only: false` within the `with` parameters of the action. It will default to `true`, which is the current behavior of the action.

📦 Dependabot 🤖

• chore(deps-dev): bump eslint-plugin-jest from 27.4.2 to 27.6.0 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/681
• chore(deps): bump codecov/codecov-action from 3 to 4 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/721
• chore(deps): bump cross-fetch from 3.1.6 to 4.0.0 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/675
• chore(deps): bump json5 from 2.2.0 to 2.2.3 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/578
• chore(deps-dev): bump typescript from 4.8.4 to 4.9.5 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/593
• chore(deps): bump github/codeql-action from 2 to 3 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/702
• chore(deps-dev): bump eslint-config-prettier from 8.5.0 to 9.1.0 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/697
• chore(deps): bump actions/upload-artifact from 3 to 4 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/703
• + 1 more

📋 What's Changed

• Made a change that assumes `tier` is optional to prevent a NPE for some users.
• Full Changelog: https://github.com/JamesIves/github-sponsors-readme-action/compare/v1.3.0...v1.3.1

📋 What's Changed

• The action is now developed against Node 20.
• The `sponsorship-status` output has been renamed to `sponsorshipStatus` to comply with best practices. This has the potential to break some workflows, but it is unlikely as the way this variable was named previously makes it difficult to interface with. As such as this has not been marked as a breaking change, I apologize if this theory ends up being inaccurate.
• Fixes an issue where if for some reason `monthlyPriceInCents` is undefined, we set the value to `0`.
• Add note for organisation usage by @0xTim in https://github.com/JamesIves/github-sponsors-readme-action/pull/538

📦 Dependencies 🤖

• chore(deps): bump @actions/core from 1.9.1 to 1.10.0 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/495
• chore(deps-dev): bump eslint from 8.24.0 to 8.27.0 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/532
• chore(deps-dev): bump eslint-plugin-jest from 27.0.4 to 27.1.5 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/539
• chore(deps-dev): bump prettier from 2.7.1 to 2.8.4 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/600
• chore(deps-dev): bump @typescript-eslint/eslint-plugin from 5.39.0 to 5.60.1 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/628
• chore(deps): bump cross-fetch from 3.1.5 to 3.1.6 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/629
• chore(deps-dev): bump eslint from 8.27.0 to 8.43.0 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/621
• chore(deps-dev): bump @types/node from 18.7.18 to 20.3.2 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/627
• + 20 more

✨ New Contributors

• @0xTim made their first contribution in https://github.com/JamesIves/github-sponsors-readme-action/pull/538
• Full Changelog: https://github.com/JamesIves/github-sponsors-readme-action/compare/v1.2.2...v1.3.0

📋 What's Changed

• The action now fully runs on Node 16. (Thank you @nickmccurdy)

📋 Changelog

• Bump eslint-plugin-jest from 26.5.3 to 26.8.7 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/453
• Bump @typescript-eslint/parser from 5.20.0 to 5.34.0 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/454
• Bump @types/node from 18.7.6 to 18.7.13 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/455
• Bump eslint-plugin-prettier from 4.0.0 to 4.2.1 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/397
• chore(deps-dev): bump @typescript-eslint/parser from 5.34.0 to 5.36.2 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/473
• chore(deps-dev): bump eslint-plugin-jest from 26.8.7 to 27.0.4 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/479
• chore(deps-dev): bump eslint from 8.22.0 to 8.23.1 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/478
• chore(deps-dev): bump @types/node from 18.7.13 to 18.7.18 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/483
• + 5 more

📋 What's Changed

• feat: fall back to `url` if `websiteUrl` is null by @robingenz in https://github.com/JamesIves/github-sponsors-readme-action/pull/448

✨ New Contributors

• @robingenz made their first contribution in https://github.com/JamesIves/github-sponsors-readme-action/pull/448

📦 Sponsors ❤️

• Special thanks to @annegentle for their generous [sponsorship](https://github.com/sponsors/JamesIves) contributions.
• Full Changelog: https://github.com/JamesIves/github-sponsors-readme-action/compare/v1...v1.2.1

📋 What's Changed

• Resolves an issue that occurs when organization accounts attempted to fetch sponsorships. This change may require personal access tokens to be re-scoped in some workflows. The new scopes required are read:user and read:org. The README has been updated to reflect this.
• Added the ability to populate a template with a user's website url if they have one set on their profile. As this field is optional is has the possibility to be `null`.
• Bump eslint from 8.14.0 to 8.18.0 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/384
• Bump @actions/core from 1.6.0 to 1.9.0 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/393
• Bump nock from 13.2.4 to 13.2.8 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/399
• Bump typescript from 4.6.4 to 4.7.4 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/383
• Update README.md by @Jieiku in https://github.com/JamesIves/github-sponsors-readme-action/pull/418
• Bump @types/mustache from 4.1.2 to 4.2.1 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/415
• + 4 more

✨ New Contributors

• @Jieiku made their first contribution in https://github.com/JamesIves/github-sponsors-readme-action/pull/418

📦 Sponsors ❤️

• Special thanks to @annegentle for their generous [sponsorship](https://github.com/sponsors/JamesIves) contributions.
• Full Changelog: https://github.com/JamesIves/github-sponsors-readme-action/compare/v1...v1.2.0

📋 Minor Changes

• Fixes an issue where organizational data was not correctly being displayed alongside user data if organization was set to true.
• Linting scripts have been updated to ensure that everything across the repo gets picked up.
• Numerous dependency updates.

✨ New Contributors

• @nickmccurdy made their first contribution in https://github.com/JamesIves/github-sponsors-readme-action/pull/390

📦 Sponsors ❤️

• Special thanks to @github for their generous [sponsorship](https://github.com/sponsors/JamesIves) contributions.
• <a href="https://github.com/github"><img src="https://github.com/github.png" width="80px" alt="github" /></a>&nbsp;&nbsp;
• Full Changelog: https://github.com/JamesIves/github-sponsors-readme-action/compare/v1...v1.1.0

📋 Minor Changes

• Introduces major version tags. You can now point your workflow to `JamesIves/github-sponsors-readme-action@v1` if you'd like to always have the most cutting edge changes outside of using the release branch directly.

📋 Minor Changes

• Dependency upgrades.

📋 Minor Changes

• Dependency bumps across the board.

📦 Commit Log

• Bump y18n from 4.0.0 to 4.0.3 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/3
• Bump nock from 13.0.0 to 13.0.11 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/4
• Bump @types/mustache from 4.0.1 to 4.1.1 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/5
• Bump @typescript-eslint/eslint-plugin from 4.22.0 to 4.22.1 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/6
• Bump prettier from 2.0.2 to 2.2.1 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/7
• Bump @actions/io from 1.0.2 to 1.1.0 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/8
• Bump jest from 25.1.0 to 25.5.4 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/9
• Bump mustache from 4.0.0 to 4.2.0 by @dependabot in https://github.com/JamesIves/github-sponsors-readme-action/pull/10
• + 41 more

✨ New Contributors

• @Lissy93 made their first contribution in https://github.com/JamesIves/github-sponsors-readme-action/pull/95
• Full Changelog: https://github.com/JamesIves/github-sponsors-readme-action/commits/1.0.6

📋 Minor Changes

• Adjusted the npm configuration.

📋 Minor Changes

• Added a `skipped` step which informs you if there is no marker found in your README.
• Large number of dependabot bumps.
• README fixes.

📋 Minor Changes

• Lots of workflow adjustments and quality of life changes.
• Fixed some README related things.
• Added Dependabot security updates.

📋 Changes

• [Discussions](https://github.com/JamesIves/github-sponsors-readme-action/discussions)
• [Issues](https://github.com/JamesIves/github-sponsors-readme-action/issues)