From 55a3879eee221a47e057d75ce26af6343b4d1b3c Mon Sep 17 00:00:00 2001 From: Jerko J <83344666+JJ-Cro@users.noreply.github.com> Date: Mon, 23 Sep 2024 14:25:41 +0200 Subject: [PATCH 1/3] feat(): added automatic Readme actions --- .github/workflows/templates-readme.yml | 89 ++++++++++++++++++++++++++ README.md | 22 +++++-- 2 files changed, 107 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/templates-readme.yml diff --git a/.github/workflows/templates-readme.yml b/.github/workflows/templates-readme.yml new file mode 100644 index 00000000..dfea3096 --- /dev/null +++ b/.github/workflows/templates-readme.yml @@ -0,0 +1,89 @@ +name: Update README.md templates + +on: + workflow_dispatch: + +permissions: + contents: write # Grant write permissions to the contents + +env: + FILE_NAME: README.md + +jobs: + update-readme: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - uses: actions/setup-node@v4 + with: + node-version-file: '.nvmrc' + registry-url: https://registry.npmjs.org/ + cache: 'npm' + + - name: Install + run: npm ci --ignore-scripts + + - name: Get the current date and time + id: datetime + run: echo "BRANCH_NAME=$(date +'actions_templates_%Y_%m_%d_%H%M%S')" >> $GITHUB_ENV + + - name: Create update-template.sh script + run: | + cat << 'EOF' > update-template.sh + #!/bin/bash + + TEMPLATE_VALUE=$(curl -s $TEMPLATE_URL) + + perl -0777 -i -pe " + my \$tag = quotemeta(''); + my \$end_tag = quotemeta(''); + my \$replacement = '${TEMPLATE_VALUE}'; + + # Match the tag, then any amount of whitespace (including newlines), then the replacement, then any amount of whitespace, then the end tag. + s/(\$tag)(\s*)(.*?)(\s*)(\$end_tag)/\$1\n\$replacement\n\$5/s; + " "$FILE_NAME" + + EOF + chmod +x update-template.sh + cat update-template.sh + + - name: Fetch and update RELATED PROJECTS template + run: ./update-template.sh + env: + TEMPLATE_URL: https://raw.githubusercontent.com/wiki/tiagosiebler/awesome-crypto-examples/Related-projects.md + TEMPLATE_TAG: related_projects + + - name: Fetch and update CONTRIBUTIONS template + run: ./update-template.sh + env: + TEMPLATE_URL: https://raw.githubusercontent.com/wiki/tiagosiebler/awesome-crypto-examples/Contributions-%26-Thanks.md + TEMPLATE_TAG: contributions + + - name: Fetch and update STAR HISTORY template + run: ./update-template.sh + env: + TEMPLATE_URL: https://raw.githubusercontent.com/wiki/tiagosiebler/awesome-crypto-examples/Star-History.md + TEMPLATE_TAG: star_history + + - name: Check for changes before running linter + run: git diff + + - name: Check for changes | PR URL HERE + id: commitIfChanged + run: | + npx prettier -w README.md + if git diff --quiet; then + echo "No changes to commit" + exit 0 + fi + git config --global user.name 'github-actions[bot]' + git config --global user.email 'github-actions[bot]@users.noreply.github.com' + git checkout -b ${{ env.BRANCH_NAME }} + git add $FILE_NAME + git commit -m 'chore(): ${{ env.FILE_NAME }} template sections' + git push origin ${{ env.BRANCH_NAME }} + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/README.md b/README.md index 0c147c91..d99494d5 100644 --- a/README.md +++ b/README.md @@ -60,14 +60,16 @@ Refer to the [examples](./examples) folder for implementation demos. - Discuss & collaborate with other node devs? Join our [Node.js Algo Traders](https://t.me/nodetraders) engineering community on telegram. - Questions about Binance APIs & WebSockets? Ask in the official [Binance API](https://t.me/binance_api_english) group on telegram. + + ## Related projects Check out my related JavaScript/TypeScript/Node.js projects: - Try my REST API & WebSocket SDKs: - [Bybit-api Node.js SDK](https://www.npmjs.com/package/bybit-api) - - [Binance Node.js SDK](https://www.npmjs.com/package/binance) - [Okx-api Node.js SDK](https://www.npmjs.com/package/okx-api) + - [Binance Node.js SDK](https://www.npmjs.com/package/binance) - [Gateio-api Node.js SDK](https://www.npmjs.com/package/gateio-api) - [Bitget-api Node.js SDK](https://www.npmjs.com/package/bitget-api) - [Bitmart-api Node.js SDK](https://www.npmjs.com/package/bitmart-api) @@ -76,6 +78,7 @@ Check out my related JavaScript/TypeScript/Node.js projects: - [Crypto Exchange Account State Cache](https://www.npmjs.com/package/accountstate) - Check out my examples: - [awesome-crypto-examples Node.js](https://github.com/tiagosiebler/awesome-crypto-examples) + ## Documentation @@ -376,7 +379,7 @@ However, note that browser usage will lead to CORS errors due to Binance. --- -## Contributions & Thanks + Have my projects helped you? Share the love, there are many ways you can show your thanks: @@ -386,12 +389,23 @@ Have my projects helped you? Share the love, there are many ways you can show yo - Or buy me all the coffee: - ETH(ERC20): `0xA3Bda8BecaB4DCdA539Dc16F9C54a592553Be06C` -For more ways to give thanks & support my efforts, visit [Contributions & Thanks](https://github.com/tiagosiebler/awesome-crypto-examples/wiki/Contributions-&-Thanks)! + + ### Contributions & Pull Requests Contributions are encouraged, I will review any incoming pull requests. See the issues tab for todo items. + + ## Star History -[![Star History Chart](https://api.star-history.com/svg?repos=tiagosiebler/bybit-api,tiagosiebler/binance,tiagosiebler/orderbooks,tiagosiebler/okx-api,tiagosiebler/bitget-api,tiagosiebler/awesome-crypto-examples,tiagosiebler/bitmart-api,tiagosiebler/gateio-api&type=Date)](https://star-history.com/#tiagosiebler/bybit-api&tiagosiebler/binance&tiagosiebler/orderbooks&tiagosiebler/okx-api&tiagosiebler/bitget-api&tiagosiebler/awesome-crypto-examples&tiagosiebler/bitmart-api&tiagosiebler/gateio-api&Date) +[![Star History Chart](https://api.star-history.com/svg?repos=tiagosiebler/bybit-api,tiagosiebler/okx-api,tiagosiebler/binance,tiagosiebler/bitget-api,tiagosiebler/bitmart-api,tiagosiebler/gateio-api,tiagosiebler/kucoin-api,tiagosiebler/orderbooks,tiagosiebler/accountstate,tiagosiebler/awesome-crypto-examples&type=Date)](https://star-history.com/#tiagosiebler/bybit-api&tiagosiebler/okx-api&tiagosiebler/binance&tiagosiebler/bitget-api&tiagosiebler/bitmart-api&tiagosiebler/gateio-api&tiagosiebler/kucoin-api&tiagosiebler/orderbooks&tiagosiebler/accountstate&tiagosiebler/awesome-crypto-examples&Date) + + From 538e78dc8e4c81e7853e9dff58ded5bf21befe3c Mon Sep 17 00:00:00 2001 From: Jerko J <83344666+JJ-Cro@users.noreply.github.com> Date: Mon, 23 Sep 2024 16:55:54 +0200 Subject: [PATCH 2/3] chore(): fixed warning --- .github/workflows/templates-readme.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/templates-readme.yml b/.github/workflows/templates-readme.yml index dfea3096..b5fc135b 100644 --- a/.github/workflows/templates-readme.yml +++ b/.github/workflows/templates-readme.yml @@ -87,3 +87,5 @@ jobs: git push origin ${{ env.BRANCH_NAME }} env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + FILE_NAME: ${{ env.FILE_NAME }} + BRANCH_NAME: ${{ env.BRANCH_NAME }} From 11b714a583cc0a166b7b0efc5f390aeb7ba27e0a Mon Sep 17 00:00:00 2001 From: Jerko J <83344666+JJ-Cro@users.noreply.github.com> Date: Mon, 23 Sep 2024 19:20:54 +0200 Subject: [PATCH 3/3] chore(): updated readme actions --- .github/workflows/templates-readme.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/templates-readme.yml b/.github/workflows/templates-readme.yml index b5fc135b..dfea3096 100644 --- a/.github/workflows/templates-readme.yml +++ b/.github/workflows/templates-readme.yml @@ -87,5 +87,3 @@ jobs: git push origin ${{ env.BRANCH_NAME }} env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - FILE_NAME: ${{ env.FILE_NAME }} - BRANCH_NAME: ${{ env.BRANCH_NAME }}