Skip to content

fix(docs-site): stop ignoring version snapshots; assert it stays that way #2313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeffredodd merged 3 commits into from
Jun 30, 2026
+16 −6
Merged

fix(docs-site): stop ignoring version snapshots; assert it stays that way #2313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c025af6
fix(ci): force-stage version snapshots in publish-docs sync
jeffredodd Jun 30, 2026
2977242
fix at source: drop version-snapshot gitignores; revert workflow work…
jeffredodd Jun 30, 2026
7745672
fix(ci): assert downstream-owned paths aren't gitignored in publish-docs
jeffredodd Jun 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/workflows/publish-docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,22 @@ jobs:
# Strip anything that shouldn't ship with source.
rm -rf docs-site/node_modules docs-site/build

# ---- Step 3a: gitignore precondition check ----
# This sync's correctness depends on docs-site/.gitignore NOT
# ignoring the downstream-owned snapshot paths. If the SDK ever
# re-introduces such rules (as #2167 did, causing snapshots to
# silently disappear from the docs repo for two weeks), fail
# loudly here rather than letting `git add` quietly skip the
# restored snapshots below.
for path in docs-site/versions.json docs-site/versioned_docs docs-site/versioned_sidebars; do
if git check-ignore -q "$path"; then
echo "ERROR: $path is gitignored by the synced docs-site/.gitignore." >&2
echo "Cross-repo sync requires this path to be tracked downstream." >&2
echo "Remove the corresponding entry from the SDK's docs-site/.gitignore." >&2
exit 1
fi
done
Comment on lines +172 to +186

@mariechatfield mariechatfield Jun 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️


# Restore the versioned files (or initialize empty placeholders if
# downstream was bare — the snapshot step below populates them).
for v in versioned_docs versioned_sidebars versions.json; do
Expand Down
6 changes: 0 additions & 6 deletions docs-site/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,3 @@ node_modules/
.docusaurus/
build/
.cache-loader/

# Version snapshots are owned by Gusto/embedded-sdk-docs; only created locally
# to develop the version-dropdown UI.
versions.json
versioned_docs/
versioned_sidebars/
Loading