-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* docs: Add sponsors to README * remove IIFE
- Loading branch information
1 parent
be6b6a5
commit cac8847
Showing
5 changed files
with
123 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| name: Data Fetch | ||
|
|
||
| on: | ||
| schedule: | ||
| - cron: "0 8 * * *" # Every day at 1am PDT | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Check out repo | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| token: ${{ secrets.WORKFLOW_PUSH_BOT_TOKEN }} | ||
|
|
||
| - name: Set up Node.js | ||
| uses: actions/setup-node@v4 | ||
|
|
||
| - name: Install npm packages | ||
| run: npm install | ||
|
|
||
| - name: Update README with latest sponsor data | ||
| run: npm run build:readme | ||
|
|
||
| - name: Setup Git | ||
| run: | | ||
| git config user.name "GitHub Actions Bot" | ||
| git config user.email "<[email protected]>" | ||
| - name: Save updated files | ||
| run: | | ||
| chmod +x ./tools/commit-readme.sh | ||
| ./tools/commit-readme.sh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| #!/bin/bash | ||
|
|
||
| #------------------------------------------------------------------------------ | ||
| # Commits the data files if any have changed | ||
| #------------------------------------------------------------------------------ | ||
|
|
||
| if [ -z "$(git status --porcelain)" ]; then | ||
| echo "Data did not change." | ||
| else | ||
| echo "Data changed!" | ||
|
|
||
| # commit the result | ||
| git add README.md | ||
| git commit -m "docs: Update README sponsors" | ||
|
|
||
| # push back to source control | ||
| git push origin HEAD | ||
| fi |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| /** | ||
| * @fileoverview Script to update the README with sponsors details in all packages. | ||
| * | ||
| * node tools/update-readme.js | ||
| * | ||
| * @author Milos Djermanovic | ||
| */ | ||
|
|
||
| //----------------------------------------------------------------------------- | ||
| // Requirements | ||
| //----------------------------------------------------------------------------- | ||
|
|
||
| import { readFileSync, writeFileSync } from "node:fs"; | ||
| import got from "got"; | ||
|
|
||
| //----------------------------------------------------------------------------- | ||
| // Data | ||
| //----------------------------------------------------------------------------- | ||
|
|
||
| const SPONSORS_URL = | ||
| "https://raw.githubusercontent.com/eslint/eslint.org/main/includes/sponsors.md"; | ||
|
|
||
| const README_FILE_PATH = "./README.md"; | ||
|
|
||
| //----------------------------------------------------------------------------- | ||
| // Helpers | ||
| //----------------------------------------------------------------------------- | ||
|
|
||
| /** | ||
| * Fetches the latest sponsors from the website. | ||
| * @returns {Promise<string>}} Prerendered sponsors markdown. | ||
| */ | ||
| async function fetchSponsorsMarkdown() { | ||
| return got(SPONSORS_URL).text(); | ||
| } | ||
|
|
||
| //----------------------------------------------------------------------------- | ||
| // Main | ||
| //----------------------------------------------------------------------------- | ||
|
|
||
| const allSponsors = await fetchSponsorsMarkdown(); | ||
|
|
||
| // read readme file | ||
| const readme = readFileSync(README_FILE_PATH, "utf8"); | ||
|
|
||
| let newReadme = readme.replace( | ||
| /<!--sponsorsstart-->[\w\W]*?<!--sponsorsend-->/u, | ||
| `<!--sponsorsstart-->\n\n${allSponsors}\n<!--sponsorsend-->`, | ||
| ); | ||
|
|
||
| // replace multiple consecutive blank lines with just one blank line | ||
| newReadme = newReadme.replace(/(?<=^|\n)\n{2,}/gu, "\n"); | ||
|
|
||
| // output to the files | ||
| writeFileSync(README_FILE_PATH, newReadme, "utf8"); |