You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
v0.2.1: docs: update README and TODO for git subtree workflow
Replace submodule instructions with git subtree approach:
- subtree add with --prefix=scripts
- named remote for convenience (git remote add repokit-common)
- pull/push commands for bidirectional sync
- note about existing scripts/ files needing temporary move
This reflects the proven setup tested with DazzleLink.
git subtree pull --prefix=scripts repokit-common main --squash
14
+
15
+
# 4. Push local improvements back upstream
16
+
git subtree push --prefix=scripts repokit-common main
17
+
```
18
+
19
+
Note: If you already have files in `scripts/`, move them out first, do the subtree add, then move them back. Git subtree requires an empty prefix directory on first add.
20
+
21
+
## Required (after subtree add)
6
22
7
23
-[ ]**Configure pyproject.toml**: Add `[tool.repokit-common]` section (hooks depend on this):
8
24
```toml
@@ -14,11 +30,11 @@ After adding `git-repokit-common` as a submodule or worktree, complete these ste
14
30
private-patterns = ["private/", "local/", ".env"]
15
31
```
16
32
-[ ]**Create `_version.py`**: Copy the version module template into your package directory and edit the initial version values
17
-
-[ ]**Install hooks**: Run `bash scripts/repokit-common/install-hooks.sh`
33
+
-[ ]**Install hooks**: Run `bash scripts/install-hooks.sh`
18
34
19
35
## Customize (as needed)
20
36
21
-
-[ ]**VHS demo tapes** (`vhs/*.tape`): Replace `repokit-common`with your actual CLI command name
37
+
-[ ]**VHS demo tapes** (`scripts/vhs/*.tape`): Replace placeholder CLI commands with your actual command name
22
38
-[ ]**demo_render.py**: Rewrite with your project's output format (the existing content is a template/example)
23
39
-[ ]**Pre-push hook**: Verify the auto-detected package directory is correct for your project
24
40
@@ -32,4 +48,5 @@ After adding `git-repokit-common` as a submodule or worktree, complete these ste
32
48
33
49
- The hooks auto-detect your Python package directory (looks for `__init__.py` at the project root)
34
50
-`sync-versions.py` reads config from `pyproject.toml [tool.repokit-common]` automatically
0 commit comments