Skip to content

Commit 87c1140

Browse files
brunoborgesCopilot
andcommitted
Document CI/CD workflows in html-generators README
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 71cbbe3 commit 87c1140

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

html-generators/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,16 @@ jbang export fatjar --output html-generators/generate.jar html-generators/genera
5959

6060
This produces a self-contained ~2.2 MB JAR with all dependencies (Jackson) bundled. The `build-generator.yml` GitHub Action does this automatically when `generate.java` changes.
6161

62+
## CI/CD Workflows
63+
64+
Two GitHub Actions workflows automate the build and deploy pipeline:
65+
66+
1. **`build-generator.yml`** — Triggered when `generate.java` changes on `main`. Uses JBang to rebuild the fat JAR and commits the updated `generate.jar` back to the repository.
67+
68+
2. **`deploy.yml`** — Triggered when content, templates, the JAR, or site assets change on `main`. Runs `java -jar html-generators/generate.jar` to regenerate all HTML pages, `snippets.json`, and `index.html`, then deploys the `site/` folder to GitHub Pages.
69+
70+
This means the deploy workflow always uses the pre-built fat JAR (no JBang required at deploy time), and the JAR stays in sync with the source automatically.
71+
6272
## Benchmark
6373

6474
See [BENCHMARK.md](BENCHMARK.md) for performance comparisons across all four execution methods (AOT, fat JAR, JBang, Python).

0 commit comments

Comments
 (0)