Skip to content

Commit 24a130b

Browse files
authored
Merge pull request #11 from webmaxru/webmaxru-gate-book-downloads
Gate book PDF downloads behind Substack
2 parents f426207 + c01af92 commit 24a130b

26 files changed

Lines changed: 109 additions & 99 deletions

‎.github/prompts/release-content.prompt.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ refresh, first run `.github/prompts/update-book.prompt.md`.
9191
## After the human merges
9292

9393
`validate-book.yml` builds and gates the exact artifacts consumed by both publishing
94-
workflows. `deploy-pages.yml` publishes that site/PDF without rebuilding;
94+
workflows. `deploy-pages.yml` publishes the online site without the gated PDF;
9595
`release-content.yml` creates `content-v<edition>` with the matching
9696
`gh-aw-book-v<edition>.pdf` and changelog notes. Verify both workflow outcomes, the release
9797
asset, and the live version-history page before calling the edition published.

‎.github/workflows/deploy-pages.yml‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,16 @@ jobs:
3939
permissions:
4040
contents: write
4141
steps:
42-
- name: Download the validated site, analytics beacon, and PDF
42+
- name: Download the validated site and analytics beacon
4343
uses: actions/download-artifact@v4
4444
with:
4545
name: validated-pages
4646
path: artifact
4747

48-
- name: Publish the exact validated site to gh-pages
48+
- name: Remove the gated PDF from the public site
49+
run: rm -f artifact/site/gh-aw-book.pdf
50+
51+
- name: Publish the validated site to gh-pages
4952
run: |
5053
cd artifact/site
5154
touch .nojekyll

‎.gitignore‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ __pycache__/
1414
dist/
1515
build/
1616

17-
# Downloadable book PDF — a binary build artifact rendered from site/book.html by
18-
# scripts/build_pdf.py (in CI on every deploy, and locally on demand). It is
19-
# published to gh-pages but not committed to main.
17+
# Book PDF — a binary build artifact rendered from site/book.html by
18+
# scripts/build_pdf.py for release assets and local use. It is not committed to main
19+
# or published on the public website.
2020
site/gh-aw-book.pdf
2121

2222
# Playwright browser-download marker (browsers install to a shared cache, not here)

‎README.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -256,13 +256,14 @@ python scripts\verify_examples.py --compiler <absolute-gh-aw-executable>
256256
257257
---
258258

259-
## Download the book as a PDF
259+
## Get the book as a PDF
260260

261-
The whole book is also available as a **single downloadable PDF**, linked from the site (home page
262-
"Download PDF", the reader nav, and every chapter). It is rendered from a **single-page edition**
263-
(`site/book.html`, which `site/generate.py` produces alongside the chapter pages) using headless
264-
Chromium via [Playwright](https://playwright.dev/python/), so code blocks keep their syntax
265-
highlighting and the PDF carries page numbers and a chapter outline.
261+
The whole book is available as a **single downloadable PDF** through the
262+
[Substack download page](https://isainative.substack.com/p/free-agentic-workflows-book). The
263+
website links to that gated page rather than publishing the PDF directly. The PDF is rendered from
264+
a **single-page edition** (`site/book.html`, which `site/generate.py` produces alongside the chapter
265+
pages) using headless Chromium via [Playwright](https://playwright.dev/python/), so code blocks keep
266+
their syntax highlighting and the PDF carries page numbers and a chapter outline.
266267

267268
```powershell
268269
# 1. (re)generate the site, including site/book.html (the PDF's source)
@@ -275,10 +276,10 @@ python scripts/build_pdf.py
275276
```
276277

277278
The PDF (`site/gh-aw-book.pdf`) is a **binary build artifact**: it is gitignored, not committed to
278-
`main`. On every push that changes the book, the deploy workflow
279-
([`.github/workflows/deploy-pages.yml`](.github/workflows/deploy-pages.yml)) regenerates it right
280-
after `generate.py` and publishes it to the live site — so the downloadable PDF always matches the
281-
current book.
279+
`main`, and removed before the site is published. The deploy workflow
280+
([`.github/workflows/deploy-pages.yml`](.github/workflows/deploy-pages.yml)) still validates the
281+
single-page source and release tooling, while the public site sends readers to the gated Substack
282+
page.
282283

283284
---
284285

‎scripts/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ not committed sources.
135135
helpers, release/evidence contract, pinned whole-corpus compilation, and HTML/PDF generation.
136136
The PR still needs human review/merge; these workflows do not configure branch protection.
137137

138-
After merge, `deploy-pages.yml` publishes the current online/PDF edition and
138+
After merge, `deploy-pages.yml` publishes the current online edition and
139139
`release-content.yml` publishes its matching tag, changelog notes, and versioned PDF.
140140
Both consume the exact artifacts produced by validation instead of rebuilding afterward.
141141
The release workflow also evaluates content/example/tooling pushes; a complete existing

‎site/book.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@
120120
</head>
121121
<body class="book">
122122
<div class="book-toolbar" role="toolbar" aria-label="Book actions">
123-
<a class="book-btn book-btn--primary" href="gh-aw-book.pdf">↓ Download PDF</a>
123+
<a class="book-btn book-btn--primary" href="https://isainative.substack.com/p/free-agentic-workflows-book" target="_blank" rel="noopener">Get the free PDF</a>
124124
<button class="book-btn" type="button" onclick="window.print()">Print / Save as PDF</button>
125125
<a class="book-btn" href="index.html">← Back to the web edition</a>
126126
</div>
@@ -130,7 +130,7 @@
130130
<h1 class="book-cover-title">GitHub Agentic Workflows</h1>
131131
<p class="book-cover-sub">A progressive guide that starts with agentic-workflow concepts and builds toward GitHub Agentic Workflows authoring, compilation, MCP tools, safe outputs, and CI hosting.</p>
132132
<p class="book-cover-author">By <strong>Maxim Salnikov</strong> · Microsoft</p>
133-
<p class="book-cover-meta"><a href="https://aw.isainative.dev/versions.html">Content edition v1.2</a> · 14 chapters · Single-page edition · Generated 2026-09-16</p>
133+
<p class="book-cover-meta"><a href="https://aw.isainative.dev/versions.html">Content edition v1.2</a> · 14 chapters · Single-page edition · Generated 2026-09-20</p>
134134
<p class="book-cover-meta"><a href="https://github.com/github/gh-aw/releases/tag/v0.88.7">Verified with gh-aw v0.88.7</a></p>
135135
</header>
136136

‎site/chapters/anatomy-and-compile-model.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999

100100
<div class="content-shell">
101101
<header class="chapter-header">
102-
<nav class="breadcrumb" aria-label="Breadcrumb"><a href="../index.html">Home</a> / Chapter 3 <span class="fm-sep">·</span> <a href="../gh-aw-book.pdf">Download PDF</a> <span class="fm-sep">·</span> <a href="../versions.html">Content edition v1.2</a> <span class="fm-sep">·</span> <a href="https://github.com/github/gh-aw/releases/tag/v0.88.7">Verified with gh-aw v0.88.7</a></nav>
102+
<nav class="breadcrumb" aria-label="Breadcrumb"><a href="../index.html">Home</a> / Chapter 3 <span class="fm-sep">·</span> <a href="https://isainative.substack.com/p/free-agentic-workflows-book" target="_blank" rel="noopener">Get the free PDF</a> <span class="fm-sep">·</span> <a href="../versions.html">Content edition v1.2</a> <span class="fm-sep">·</span> <a href="https://github.com/github/gh-aw/releases/tag/v0.88.7">Verified with gh-aw v0.88.7</a></nav>
103103
<p class="fm"><span class="fm-k">chapter:</span> <span class="fm-v">03</span><span class="fm-sep">·</span><span class="fm-k">part:</span> <span class="fm-v">The Individual (one workflow)</span></p>
104104
<h1>Anatomy &amp; the Compile Model</h1>
105105
<p class="lead">Read any workflow&#x27;s frontmatter + Markdown, run the compile-and-iterate loop, and understand what the generated .lock.yml contains.</p>
@@ -371,7 +371,7 @@ <h2 id="recap-and-what-s-next"><a class="anchor-link" href="#recap-and-what-s-ne
371371
</main>
372372

373373
<footer class="site-footer chapter-footer">
374-
<p>By <strong>Maxim Salnikov</strong> · Microsoft · <a href="https://www.linkedin.com/in/webmax/" target="_blank" rel="noopener">LinkedIn</a> · <a href="https://github.com/webmaxru/github-agentic-workflows-book" target="_blank" rel="noopener">Book repository on GitHub ↗</a> · <a href="../gh-aw-book.pdf">Download the PDF</a> · <a href="../versions.html">Content edition v1.2</a> · <a href="https://github.com/github/gh-aw/releases/tag/v0.88.7">Verified with gh-aw v0.88.7</a></p>
374+
<p>By <strong>Maxim Salnikov</strong> · Microsoft · <a href="https://www.linkedin.com/in/webmax/" target="_blank" rel="noopener">LinkedIn</a> · <a href="https://github.com/webmaxru/github-agentic-workflows-book" target="_blank" rel="noopener">Book repository on GitHub ↗</a> · <a href="https://isainative.substack.com/p/free-agentic-workflows-book" target="_blank" rel="noopener">Get the free PDF</a> · <a href="../versions.html">Content edition v1.2</a> · <a href="https://github.com/github/gh-aw/releases/tag/v0.88.7">Verified with gh-aw v0.88.7</a></p>
375375
</footer>
376376
</div>
377377
</div>

‎site/chapters/continuous-review-and-testing.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999

100100
<div class="content-shell">
101101
<header class="chapter-header">
102-
<nav class="breadcrumb" aria-label="Breadcrumb"><a href="../index.html">Home</a> / Chapter 10 <span class="fm-sep">·</span> <a href="../gh-aw-book.pdf">Download PDF</a> <span class="fm-sep">·</span> <a href="../versions.html">Content edition v1.2</a> <span class="fm-sep">·</span> <a href="https://github.com/github/gh-aw/releases/tag/v0.88.7">Verified with gh-aw v0.88.7</a></nav>
102+
<nav class="breadcrumb" aria-label="Breadcrumb"><a href="../index.html">Home</a> / Chapter 10 <span class="fm-sep">·</span> <a href="https://isainative.substack.com/p/free-agentic-workflows-book" target="_blank" rel="noopener">Get the free PDF</a> <span class="fm-sep">·</span> <a href="../versions.html">Content edition v1.2</a> <span class="fm-sep">·</span> <a href="https://github.com/github/gh-aw/releases/tag/v0.88.7">Verified with gh-aw v0.88.7</a></nav>
103103
<p class="fm"><span class="fm-k">chapter:</span> <span class="fm-v">10</span><span class="fm-sep">·</span><span class="fm-k">part:</span> <span class="fm-v">The Team (safe, reviewed, patterned)</span></p>
104104
<h1>Continuous Review, Testing &amp; CI-Doctor</h1>
105105
<p class="lead">Close the quality loop with Review, Testing, CI-Doctor, and Refactoring patterns while keeping humans on the merge decision.</p>
@@ -383,7 +383,7 @@ <h2 id="recap-and-what-s-next"><a class="anchor-link" href="#recap-and-what-s-ne
383383
</main>
384384

385385
<footer class="site-footer chapter-footer">
386-
<p>By <strong>Maxim Salnikov</strong> · Microsoft · <a href="https://www.linkedin.com/in/webmax/" target="_blank" rel="noopener">LinkedIn</a> · <a href="https://github.com/webmaxru/github-agentic-workflows-book" target="_blank" rel="noopener">Book repository on GitHub ↗</a> · <a href="../gh-aw-book.pdf">Download the PDF</a> · <a href="../versions.html">Content edition v1.2</a> · <a href="https://github.com/github/gh-aw/releases/tag/v0.88.7">Verified with gh-aw v0.88.7</a></p>
386+
<p>By <strong>Maxim Salnikov</strong> · Microsoft · <a href="https://www.linkedin.com/in/webmax/" target="_blank" rel="noopener">LinkedIn</a> · <a href="https://github.com/webmaxru/github-agentic-workflows-book" target="_blank" rel="noopener">Book repository on GitHub ↗</a> · <a href="https://isainative.substack.com/p/free-agentic-workflows-book" target="_blank" rel="noopener">Get the free PDF</a> · <a href="../versions.html">Content edition v1.2</a> · <a href="https://github.com/github/gh-aw/releases/tag/v0.88.7">Verified with gh-aw v0.88.7</a></p>
387387
</footer>
388388
</div>
389389
</div>

‎site/chapters/continuous-triage-and-docs.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999

100100
<div class="content-shell">
101101
<header class="chapter-header">
102-
<nav class="breadcrumb" aria-label="Breadcrumb"><a href="../index.html">Home</a> / Chapter 9 <span class="fm-sep">·</span> <a href="../gh-aw-book.pdf">Download PDF</a> <span class="fm-sep">·</span> <a href="../versions.html">Content edition v1.2</a> <span class="fm-sep">·</span> <a href="https://github.com/github/gh-aw/releases/tag/v0.88.7">Verified with gh-aw v0.88.7</a></nav>
102+
<nav class="breadcrumb" aria-label="Breadcrumb"><a href="../index.html">Home</a> / Chapter 9 <span class="fm-sep">·</span> <a href="https://isainative.substack.com/p/free-agentic-workflows-book" target="_blank" rel="noopener">Get the free PDF</a> <span class="fm-sep">·</span> <a href="../versions.html">Content edition v1.2</a> <span class="fm-sep">·</span> <a href="https://github.com/github/gh-aw/releases/tag/v0.88.7">Verified with gh-aw v0.88.7</a></nav>
103103
<p class="fm"><span class="fm-k">chapter:</span> <span class="fm-v">09</span><span class="fm-sep">·</span><span class="fm-k">part:</span> <span class="fm-v">The Team (safe, reviewed, patterned)</span></p>
104104
<h1>Continuous Triage &amp; Docs: Reading the Room</h1>
105105
<p class="lead">Ship two production-shaped patterns — Continuous Triage and Continuous Docs — as mini-products the Repo Assistant runs on its own.</p>
@@ -418,7 +418,7 @@ <h2 id="recap-and-what-s-next"><a class="anchor-link" href="#recap-and-what-s-ne
418418
</main>
419419

420420
<footer class="site-footer chapter-footer">
421-
<p>By <strong>Maxim Salnikov</strong> · Microsoft · <a href="https://www.linkedin.com/in/webmax/" target="_blank" rel="noopener">LinkedIn</a> · <a href="https://github.com/webmaxru/github-agentic-workflows-book" target="_blank" rel="noopener">Book repository on GitHub ↗</a> · <a href="../gh-aw-book.pdf">Download the PDF</a> · <a href="../versions.html">Content edition v1.2</a> · <a href="https://github.com/github/gh-aw/releases/tag/v0.88.7">Verified with gh-aw v0.88.7</a></p>
421+
<p>By <strong>Maxim Salnikov</strong> · Microsoft · <a href="https://www.linkedin.com/in/webmax/" target="_blank" rel="noopener">LinkedIn</a> · <a href="https://github.com/webmaxru/github-agentic-workflows-book" target="_blank" rel="noopener">Book repository on GitHub ↗</a> · <a href="https://isainative.substack.com/p/free-agentic-workflows-book" target="_blank" rel="noopener">Get the free PDF</a> · <a href="../versions.html">Content edition v1.2</a> · <a href="https://github.com/github/gh-aw/releases/tag/v0.88.7">Verified with gh-aw v0.88.7</a></p>
422422
</footer>
423423
</div>
424424
</div>

‎site/chapters/defense-in-depth.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999

100100
<div class="content-shell">
101101
<header class="chapter-header">
102-
<nav class="breadcrumb" aria-label="Breadcrumb"><a href="../index.html">Home</a> / Chapter 7 <span class="fm-sep">·</span> <a href="../gh-aw-book.pdf">Download PDF</a> <span class="fm-sep">·</span> <a href="../versions.html">Content edition v1.2</a> <span class="fm-sep">·</span> <a href="https://github.com/github/gh-aw/releases/tag/v0.88.7">Verified with gh-aw v0.88.7</a></nav>
102+
<nav class="breadcrumb" aria-label="Breadcrumb"><a href="../index.html">Home</a> / Chapter 7 <span class="fm-sep">·</span> <a href="https://isainative.substack.com/p/free-agentic-workflows-book" target="_blank" rel="noopener">Get the free PDF</a> <span class="fm-sep">·</span> <a href="../versions.html">Content edition v1.2</a> <span class="fm-sep">·</span> <a href="https://github.com/github/gh-aw/releases/tag/v0.88.7">Verified with gh-aw v0.88.7</a></nav>
103103
<p class="fm"><span class="fm-k">chapter:</span> <span class="fm-v">07</span><span class="fm-sep">·</span><span class="fm-k">part:</span> <span class="fm-v">The Team (safe, reviewed, patterned)</span></p>
104104
<h1>Defense in Depth: Permissions, Firewall &amp; Strict Mode</h1>
105105
<p class="lead">Reduce a workflow&#x27;s authority and exposure with least-privilege permissions, runtime isolation, egress controls, and strict mode while explaining the remaining risks.</p>
@@ -376,7 +376,7 @@ <h2 id="recap-and-what-s-next"><a class="anchor-link" href="#recap-and-what-s-ne
376376
</main>
377377

378378
<footer class="site-footer chapter-footer">
379-
<p>By <strong>Maxim Salnikov</strong> · Microsoft · <a href="https://www.linkedin.com/in/webmax/" target="_blank" rel="noopener">LinkedIn</a> · <a href="https://github.com/webmaxru/github-agentic-workflows-book" target="_blank" rel="noopener">Book repository on GitHub ↗</a> · <a href="../gh-aw-book.pdf">Download the PDF</a> · <a href="../versions.html">Content edition v1.2</a> · <a href="https://github.com/github/gh-aw/releases/tag/v0.88.7">Verified with gh-aw v0.88.7</a></p>
379+
<p>By <strong>Maxim Salnikov</strong> · Microsoft · <a href="https://www.linkedin.com/in/webmax/" target="_blank" rel="noopener">LinkedIn</a> · <a href="https://github.com/webmaxru/github-agentic-workflows-book" target="_blank" rel="noopener">Book repository on GitHub ↗</a> · <a href="https://isainative.substack.com/p/free-agentic-workflows-book" target="_blank" rel="noopener">Get the free PDF</a> · <a href="../versions.html">Content edition v1.2</a> · <a href="https://github.com/github/gh-aw/releases/tag/v0.88.7">Verified with gh-aw v0.88.7</a></p>
380380
</footer>
381381
</div>
382382
</div>

0 commit comments

Comments
 (0)