Skip to content

Commit 688dea3

Browse files
brunoborgesCopilot
andcommitted
Rename Generate.java to generate.java
Update all references in README, deploy workflow, copilot instructions, check-new-jdk workflow, and .gitignore. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 4124e64 commit 688dea3

File tree

6 files changed

+16
-16
lines changed

6 files changed

+16
-16
lines changed

.github/copilot-instructions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ content/streams/stream-tolist.json
2222

2323
### Generated Files (DO NOT EDIT)
2424

25-
The following are **generated by `Generate.java`** and must not be edited directly:
25+
The following are **generated by `generate.java`** and must not be edited directly:
2626

2727
- `site/language/*.html`, `site/collections/*.html`, etc. — detail pages
2828
- `site/data/snippets.json` — aggregated search index
2929

30-
Run `jbang Generate.java` to rebuild all generated files from the JSON sources.
30+
Run `jbang generate.java` to rebuild all generated files from the JSON sources.
3131

3232
### Manually Maintained Files
3333

@@ -42,7 +42,7 @@ Run `jbang Generate.java` to rebuild all generated files from the JSON sources.
4242
content/ # Source JSON files (one per pattern, organized by category)
4343
site/ # Deployable site (static assets + generated HTML)
4444
templates/ # HTML template for detail pages
45-
Generate.java # JBang build script (Java 25)
45+
generate.java # JBang build script (Java 25)
4646
generate.py # Python build script (alternative, produces identical output)
4747
```
4848

@@ -111,11 +111,11 @@ Each `content/category/slug.json` file has this structure:
111111
1. Create `content/category/new-slug.json` with all required fields
112112
2. Update `prev`/`next` in the adjacent patterns' JSON files
113113
3. Add a preview card in `site/index.html`
114-
4. Run `jbang Generate.java`
114+
4. Run `jbang generate.java`
115115

116116
## Local Development
117117

118118
```bash
119-
jbang Generate.java # Build HTML pages + snippets.json
119+
jbang generate.java # Build HTML pages + snippets.json
120120
python3 -m http.server -d site 8090 # Serve locally
121121
```

.github/workflows/check-new-jdk.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,10 @@ code comparisons showing old Java patterns next to their modern replacements.
7878
- The snippet count in `site/index.html` uses `{{snippetCount}}` placeholders — it is updated
7979
automatically by the generator.
8080
- Do **NOT** edit `site/data/snippets.json` or any HTML files in `site/` category subfolders — these are
81-
generated by `Generate.java` and must not be modified directly.
81+
generated by `generate.java` and must not be modified directly.
8282

8383
5. **Verify the build.**
84-
- Run `jbang Generate.java` to regenerate all HTML pages and `site/data/snippets.json`.
84+
- Run `jbang generate.java` to regenerate all HTML pages and `site/data/snippets.json`.
8585
- Confirm the new pages were generated successfully.
8686

8787
6. **Create a pull request.**
@@ -94,7 +94,7 @@ code comparisons showing old Java patterns next to their modern replacements.
9494
- Only include features that are **final** (non-preview) in the new JDK release.
9595
- Label preview features as preview if you choose to include them, with "(Preview)" in the modernLabel.
9696
- All content goes in `content/{category}/{slug}.json` files — never edit generated HTML or `site/data/snippets.json`.
97-
- Run `jbang Generate.java` after making changes to verify the build.
97+
- Run `jbang generate.java` after making changes to verify the build.
9898
- Do not modify existing snippet JSON files unless a feature graduated from preview to final.
9999
- If a previously preview feature is now final, update its `modernLabel` and `support` text
100100
to remove the "(Preview)" label in its JSON file.

.github/workflows/deploy.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ on:
66
paths:
77
- 'content/*/**.json'
88
- 'templates/**'
9-
- 'Generate.java'
9+
- 'generate.java'
1010
- 'site/**'
1111
workflow_dispatch:
1212

@@ -36,11 +36,11 @@ jobs:
3636
uses: actions/cache@v4
3737
with:
3838
path: ~/.jbang
39-
key: jbang-${{ runner.os }}-${{ hashFiles('Generate.java') }}
39+
key: jbang-${{ runner.os }}-${{ hashFiles('generate.java') }}
4040
restore-keys: jbang-${{ runner.os }}-
4141

4242
- name: Generate HTML pages and snippets.json
43-
run: jbang Generate.java
43+
run: jbang generate.java
4444

4545
- name: Setup Pages
4646
uses: actions/configure-pages@v5

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Generated HTML detail pages (built by Generate.java from JSON sources)
1+
# Generated HTML detail pages (built by generate.java from JSON sources)
22
site/language/*.html
33
site/collections/*.html
44
site/strings/*.html
@@ -10,5 +10,5 @@ site/datetime/*.html
1010
site/security/*.html
1111
site/tooling/*.html
1212

13-
# Generated aggregate file (built by Generate.java from individual JSON sources)
13+
# Generated aggregate file (built by generate.java from individual JSON sources)
1414
site/data/snippets.json

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ This site uses a **JSON-first** build pipeline:
3838

3939
- **Source of truth**: Individual `category/slug.json` files (85 across 10 category folders)
4040
- **Template**: `slug-template.html` — shared HTML template with `{{placeholder}}` tokens
41-
- **Generator**: `Generate.java` — a [JBang](https://jbang.dev) script that produces all HTML detail pages and `data/snippets.json`
41+
- **Generator**: `generate.java` — a [JBang](https://jbang.dev) script that produces all HTML detail pages and `data/snippets.json`
4242
- **Deploy**: GitHub Actions runs the generator and deploys to GitHub Pages
4343

4444
Generated files (`category/*.html` and `data/snippets.json`) are in `.gitignore` — never edit them directly.
@@ -54,7 +54,7 @@ Generated files (`category/*.html` and `data/snippets.json`) are in `.gitignore`
5454

5555
```bash
5656
# Generate all HTML pages and data/snippets.json into site/
57-
jbang Generate.java
57+
jbang generate.java
5858

5959
# Serve locally
6060
python3 -m http.server -d site 8090
@@ -76,7 +76,7 @@ Contributions are welcome! Content is managed as JSON files — never edit gener
7676
1. Fork the repo
7777
2. Create or edit a JSON file in the appropriate content folder (e.g. `content/language/my-feature.json`)
7878
3. Follow the [snippet JSON schema](.github/copilot-instructions.md) for all required fields
79-
4. Run `jbang Generate.java` to verify your changes build correctly
79+
4. Run `jbang generate.java` to verify your changes build correctly
8080
5. Update `site/index.html` with a new preview card if adding a new snippet
8181
6. Open a pull request
8282

File renamed without changes.

0 commit comments

Comments
 (0)