Skip to content

Commit d105ab9

Browse files
committed
Transform to table structure. Please have a look at CONTRIBUTING.md
1 parent e4fa6f4 commit d105ab9

20 files changed

+9537
-2326
lines changed

.github/pull_request_template.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
<!--
2-
Please read the CONTRIBUTING.md first. The most important parts regarding the actual entry:
2+
Never ever change the README.md directly!
33
4-
- Write about it's unique selling point compared to other projects.
5-
- If it's a commercial project, then mark it as such, e.g. `[Title ![c]](URL)`.
6-
- Ensure that you provide concise and informative descriptions.
7-
- Do not use a description like "A library/project/tool/framework for JSON processing in Java" since all of this is implied.
8-
- Finish the description with a dot.
9-
- Try to order it alphabetically.
4+
Add your contributions to the CONTRIBUTE_README.md!
5+
6+
Please read the CONTRIBUTING.md first!
107
-->
Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
name: Update README from CONTRIBUTE_README
2+
3+
on:
4+
push:
5+
branches: [master]
6+
paths:
7+
- "CONTRIBUTE_README.md"
8+
- "scripts/*.java"
9+
pull_request:
10+
branches: [master]
11+
paths:
12+
- "CONTRIBUTE_README.md"
13+
- "scripts/*.java"
14+
workflow_dispatch:
15+
16+
jobs:
17+
update-readme:
18+
runs-on: ubuntu-latest
19+
20+
steps:
21+
- name: Checkout repository
22+
uses: actions/checkout@v4
23+
with:
24+
token: ${{ secrets.GITHUB_TOKEN }}
25+
fetch-depth: 0
26+
27+
- name: Set up Java
28+
uses: actions/setup-java@v4
29+
with:
30+
distribution: "temurin"
31+
java-version: "25"
32+
33+
- name: Step 1 - Validate Input
34+
run: |
35+
echo "Step 1: Validating input file..."
36+
java --enable-preview --source 25 scripts/step_1_validate_input.java
37+
38+
- name: Step 2 - Parse Projects
39+
run: |
40+
echo "Step 2: Parsing project entries..."
41+
java --enable-preview --source 25 scripts/step_2_parse_projects.java
42+
43+
- name: Step 3 - Generate Badges
44+
run: |
45+
echo "Step 3: Generating GitHub badges..."
46+
java --enable-preview --source 25 scripts/step_3_generate_badges.java
47+
48+
- name: Step 4 - Generate Tables
49+
run: |
50+
echo "Step 4: Generating HTML tables..."
51+
java --enable-preview --source 25 scripts/step_4_generate_tables.java
52+
53+
- name: Step 5 - Assemble README
54+
run: |
55+
echo "Step 5: Assembling final README..."
56+
java --enable-preview --source 25 scripts/step_5_assemble_readme.java
57+
58+
- name: Step 6 - Validate Transformation
59+
run: |
60+
echo "Step 6: Validating transformation..."
61+
java --enable-preview --source 25 scripts/step_6_validate_transformation.java
62+
63+
- name: Check for changes
64+
id: changes
65+
run: |
66+
if git diff --quiet README.md; then
67+
echo "No changes to README.md"
68+
echo "changed=false" >> $GITHUB_OUTPUT
69+
else
70+
echo "Changes detected in README.md"
71+
echo "changed=true" >> $GITHUB_OUTPUT
72+
fi
73+
74+
- name: Commit and push changes
75+
if: steps.changes.outputs.changed == 'true'
76+
run: |
77+
git config --local user.email "[email protected]"
78+
git config --local user.name "GitHub Action"
79+
git add README.md
80+
git commit -m "Auto-update README.md from CONTRIBUTE_README.md
81+
82+
- Converted list format to HTML tables
83+
- Added GitHub stars and last commit badges
84+
- Updated via GitHub Actions workflow"
85+
git push
86+
echo "Changes committed and pushed to repository"
87+
88+
- name: Create summary
89+
run: |
90+
echo "## Workflow Summary" >> $GITHUB_STEP_SUMMARY
91+
echo "" >> $GITHUB_STEP_SUMMARY
92+
echo "### Completed Steps:" >> $GITHUB_STEP_SUMMARY
93+
echo "1. Checked out repository" >> $GITHUB_STEP_SUMMARY
94+
echo "2. Set up Java 25" >> $GITHUB_STEP_SUMMARY
95+
echo "3. Step 1: Validated input file" >> $GITHUB_STEP_SUMMARY
96+
echo "4. Step 2: Parsed project entries" >> $GITHUB_STEP_SUMMARY
97+
echo "5. Step 3: Generated GitHub badges" >> $GITHUB_STEP_SUMMARY
98+
echo "6. Step 4: Generated HTML tables" >> $GITHUB_STEP_SUMMARY
99+
echo "7. Step 5: Assembled final README" >> $GITHUB_STEP_SUMMARY
100+
echo "8. Step 6: Validated transformation" >> $GITHUB_STEP_SUMMARY
101+
if [ "${{ steps.changes.outputs.changed }}" == "true" ]; then
102+
echo "9. Committed and pushed changes" >> $GITHUB_STEP_SUMMARY
103+
else
104+
echo "9. No changes detected" >> $GITHUB_STEP_SUMMARY
105+
fi
106+
echo "" >> $GITHUB_STEP_SUMMARY
107+
echo "### File Statistics:" >> $GITHUB_STEP_SUMMARY
108+
echo "- **Lines**: $(wc -l < README.md)" >> $GITHUB_STEP_SUMMARY
109+
echo "- **Size**: $(du -h README.md | cut -f1)" >> $GITHUB_STEP_SUMMARY
110+
echo "- **Badges**: $(grep -c 'img.shields.io' README.md)" >> $GITHUB_STEP_SUMMARY

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
.idea/
22
.vscode/
3-
.scripts/
3+
.tmp/
4+
.tool-versions

.tool-versions

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
java temurin-25.0.0+36.0.LTS

0 commit comments

Comments
 (0)