Skip to content

Commit 2eb1941

Browse files
authored
Regenerate the building page from BUILDING.md (#287)
The release workflow's new drift check caught this on its first run: BUILDING.md gained the post-release changelog instructions, but docs/building.html is generated from it and was never rebuilt, so the published page did not show them. Exactly the failure mode the check exists for.
1 parent 81f670c commit 2eb1941

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

docs/building.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,17 @@ <h2 dir="auto">Building a Release (Maintainers)</h2>
130130
verifies the result with <code class="notranslate">spctl</code>. The DMG lands in the repo root as<br>
131131
<code class="notranslate">Zerm_X.Y.Z_aarch64.dmg</code>, ready for <code class="notranslate">gh release upload</code>.</p>
132132
<p dir="auto"><code class="notranslate">SKIP_NOTARIZE=1 scripts/release.sh</code> does a signing-only dry run.</p>
133+
<h3 dir="auto">After publishing the GitHub Release</h3>
134+
<p dir="auto">The site changelog is generated from the <strong>published</strong> GitHub Releases, so it can<br>
135+
only be rebuilt once the release exists:</p>
136+
<div class="highlight highlight-source-shell" dir="auto"><pre class="notranslate">node scripts/build-site.mjs
137+
git add docs/ <span class="pl-k">&amp;&amp;</span> git commit -m <span class="pl-s"><span class="pl-pds">"</span>Regenerate site changelog from releases<span class="pl-pds">"</span></span></pre></div>
138+
<p dir="auto">Open that as a PR — Production takes changes by pull request only.</p>
139+
<p dir="auto">This is a manual step on purpose. The Release workflow cannot do it for you: it<br>
140+
can create a properly signed commit, but the organization forbids GitHub Actions<br>
141+
from opening pull requests, and Production requires one. The workflow therefore<br>
142+
checks for drift and fails loudly if the site is behind, rather than pretending<br>
143+
to publish.</p>
133144
<hr>
134145
<h2 dir="auto">Manual Build Process (Alternative)</h2>
135146
<p dir="auto">If you prefer to build manually or need more control over the build process, follow these steps:</p>

0 commit comments

Comments
 (0)