Skip to content

Commit b8c50d9

Browse files
Add readme badges and update linting (#118)
* docs: add lint job and gh-cli script count badges * fix: make lint comment headers consistent with badges * docs: add stars badge to README.md * docs: update badge links * docs: update links in README.md for folder categories
1 parent d76bedc commit b8c50d9

File tree

2 files changed

+18
-8
lines changed

2 files changed

+18
-8
lines changed

.github/workflows/lint-readme.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ jobs:
7070
- name: Process Lint Results
7171
id: process-results
7272
run: |
73-
echo "## 📋 README Lint Results" > comment.md
73+
echo "## 📋 Lint Results" > comment.md
7474
echo "" >> comment.md
7575
7676
# Function to process lint results
@@ -90,8 +90,8 @@ jobs:
9090
}
9191
9292
# Process both README results
93-
process_lint_results "⚡ gh-cli/README.md" "./lint-results/gh-cli-readme-lint-results/gh-cli-readme-lint-results.txt"
94-
process_lint_results "🔧 scripts/README.md" "./lint-results/scripts-readme-lint-results/scripts-readme-lint-results.txt"
93+
process_lint_results "⚡ ./gh-cli scripts" "./lint-results/gh-cli-readme-lint-results/gh-cli-readme-lint-results.txt"
94+
process_lint_results "🔧 ./scripts scripts" "./lint-results/scripts-readme-lint-results/scripts-readme-lint-results.txt"
9595
9696
echo "---" >> comment.md
9797
echo "*Lint results updated at $(date)*" >> comment.md

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,27 @@
11
# github-misc-scripts
22

3+
[![./gh-cli scripts](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/joshjohanning/badges/main/github-misc-scripts/gh-cli-count.json)][gh-cli]
4+
[![./scripts scripts](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/joshjohanning/badges/main/github-misc-scripts/scripts-count.json)][scripts]
5+
[![linting workflow](https://img.shields.io/github/actions/workflow/status/joshjohanning/github-misc-scripts/lint-readme.yml?logo=github&label=linting%20workflow&color=brightgreen&labelColor=gray)][ci]
6+
[![stars](https://img.shields.io/github/stars/joshjohanning/github-misc-scripts?style=flat&logo=github&color=yellow&label=stars%20★)][stars]
7+
38
Miscellaneous GitHub scripts, `gh` commands, API calls, GraphQL queries, etc. for power user automation.
49

510
See the folder categories:
611

7-
- [api](/api/README.md) *direct API calls using `curl`*
8-
- **[gh-cli](/gh-cli/README.md)** 🚀 ✨ ⬅️ *most updated and comprehensive scripts using `gh`, `gh api`, and `gh api graphql`!*
9-
- [git](/git/README.md) *Git-related scripts/commands*
10-
- [graphql](/graphql/README.md) *GraphQL queries using `curl`*
11-
- [scripts](/scripts/README.md) *standalone scripts and specialized tools*
12+
- [api](/api) *direct API calls using `curl`*
13+
- **[gh-cli](/gh-cli)** 🚀 ✨ ⬅️ *most updated and comprehensive scripts using `gh`, `gh api`, and `gh api graphql`!*
14+
- [git](/git) *Git-related scripts/commands*
15+
- [graphql](/graphql) *GraphQL queries using `curl`*
16+
- [scripts](/scripts) *standalone scripts and specialized tools*
1217

1318
> [!TIP]
1419
> The **[gh-cli](/gh-cli/README.md)** folder is the most maintained; I've started adding both API and GraphQL queries in there using `gh api` and `gh api graphql` commands.
1520
1621
> [!IMPORTANT]
1722
> Your script contribution is welcome! ⭐️ Please see the **[CONTRIBUTING.md](CONTRIBUTING.md)** file for more details.
23+
24+
[gh-cli]: https://github.com/joshjohanning/github-misc-scripts/tree/main/gh-cli#readme
25+
[scripts]: https://github.com/joshjohanning/github-misc-scripts/tree/main/scripts#readme
26+
[ci]: https://github.com/joshjohanning/github-misc-scripts/actions/workflows/lint-readme.yml
27+
[stars]: https://github.com/joshjohanning/github-misc-scripts/stargazers

0 commit comments

Comments
 (0)