Skip to content

Commit 8b1a899

Browse files
committed
docs: add instructions for working with forks and fetching upstream tags
1 parent 61a3bfa commit 8b1a899

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,17 @@ To clone the scripts repo and pick a version:
102102
* list releases (e.g. all Alpha releases): `git tag -l alpha-*`
103103
* check out the release version, e.g. `3033.0.0`: `git checkout 3033.0.0`
104104

105+
### Working with forks
106+
107+
If you're working with a fork of the scripts repository, you'll need to fetch the upstream tags to avoid version detection issues:
108+
109+
```bash
110+
git remote add upstream https://github.com/flatcar/scripts.git
111+
git fetch --tags upstream
112+
```
113+
114+
This is necessary because the SDK uses `git describe --tags` to determine the current version, and forks don't include the original repository's tags by default.
115+
105116
To use the SDK container:
106117
* Fetch image and start the SDK container: `./run_sdk_container -t`
107118
This will fetch the container image of the "scripts" repo's release version you checked out.

0 commit comments

Comments
 (0)