mirrors/flatcar-scripts
1
0
Fork 0
mirror of https://github.com/flatcar/scripts.git synced 2025-08-13 07:56:57 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: add instructions for working with forks and fetching upstream tags

Browse Source
This commit is contained in:
Jan Bronicki 2025-06-06 13:24:24 +02:00
parent 61a3bfaa25
commit 8b1a899014
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -102,6 +102,17 @@ To clone the scripts repo and pick a version:
* list releases (e.g. all Alpha releases): `git tag -l alpha-*` * list releases (e.g. all Alpha releases): `git tag -l alpha-*`
* check out the release version, e.g. `3033.0.0`: `git checkout 3033.0.0` * check out the release version, e.g. `3033.0.0`: `git checkout 3033.0.0`
### Working with forks
If you're working with a fork of the scripts repository, you'll need to fetch the upstream tags to avoid version detection issues:
```bash
git remote add upstream https://github.com/flatcar/scripts.git
git fetch --tags upstream
```
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.
To use the SDK container: To use the SDK container:
* Fetch image and start the SDK container: `./run_sdk_container -t` * Fetch image and start the SDK container: `./run_sdk_container -t`
This will fetch the container image of the "scripts" repo's release version you checked out. This will fetch the container image of the "scripts" repo's release version you checked out.