Skip to content

Commit 90865b3

Browse files
committed
docs: stop explaining a submodule loop that no longer exists
Since the pin moved to ff4e11e, TechEngine carries no submodule, so a recursive checkout has nothing to loop on. The comments in pages.yml, pr-checks.yml, final-check.yml and build-api.sh, and two notes in the README, still warned about it. The checkouts stay plain and non-recursive; only the wording changes.
1 parent 9d33573 commit 90865b3

5 files changed

Lines changed: 10 additions & 11 deletions

File tree

‎.github/scripts/build-api.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# (data/_verify/status.json) with the pinned TechEngine, and check the result.
55
# pages.yml runs this before publishing.
66
#
7-
# Needs the TechEngine submodule checked out (never recursively) and its
7+
# Needs the TechEngine submodule checked out and its
88
# dependencies installed: python -m pip install -e ./TechEngine
99
set -euo pipefail
1010

‎.github/workflows/final-check.yml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,9 @@ jobs:
3535
env:
3636
PYTHONIOENCODING: utf-8
3737
steps:
38-
# The merge commit, as pages.yml would build it after merging. Not
39-
# recursive: TechEngine carries TechAPI as its own submodule.
38+
# The merge commit, as pages.yml would build it after merging. A plain,
39+
# non-recursive submodule checkout is all it needs: TechEngine has no
40+
# submodules of its own.
4041
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
4142
with:
4243
fetch-depth: 2

‎.github/workflows/pages.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ jobs:
3030
steps:
3131
# Full history: the dump stamps created_at/updated_at from git log of
3232
# data/ (a shallow clone stamps every record with the tip time), and the
33-
# growth chart reads old commits. Submodules are not recursive: TechEngine
34-
# carries TechAPI as its own submodule.
33+
# growth chart reads old commits. A plain, non-recursive submodule
34+
# checkout is all it needs: TechEngine has no submodules of its own.
3535
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
3636
with:
3737
fetch-depth: 0

‎.github/workflows/pr-checks.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ jobs:
2929
steps:
3030
# The pull_request ref is GitHub's merge commit. Depth 2 brings both
3131
# parents, so HEAD^1 is the base the PR merges into: no deepening, no
32-
# second checkout. submodules: true is NOT recursive (TechEngine carries
33-
# TechAPI as its own submodule; recursion re-clones ~1.8 GB).
32+
# second checkout. submodules: true is a plain, non-recursive checkout,
33+
# which is all it needs: TechEngine has no submodules of its own.
3434
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
3535
with:
3636
fetch-depth: 2

‎README.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ only the hand-made `site/public/v1/games/index.json` pointer is. To preview the
3939
site with the API locally:
4040

4141
```bash
42-
git submodule update --init TechEngine # never --recursive
42+
git submodule update --init TechEngine
4343
python -m pip install -e ./TechEngine
4444
bash .github/scripts/build-api.sh # validates, then writes site/public/v1
4545
cd site && npm ci && npm run dev
@@ -99,9 +99,7 @@ This repo follows git-flow:
9999

100100
A release is a PR from `develop` to `main`; merging it deploys the site.
101101
The TechEngine pin and the pinned action SHAs are bumped by hand, in a PR into
102-
`develop` that pr-checks validates like any other. Dependabot can't do it:
103-
TechEngine carries TechAPI as its own submodule, and Dependabot's recursive
104-
clone runs out of disk on that loop.
102+
`develop` that pr-checks validates like any other; Dependabot is not used.
105103

106104
## Contributing
107105

0 commit comments

Comments
 (0)