From 8b1a899014f321bfc82ee3d676d9ffec204cad4d Mon Sep 17 00:00:00 2001 From: Jan Bronicki Date: Fri, 6 Jun 2025 13:24:24 +0200 Subject: [PATCH 1/4] docs: add instructions for working with forks and fetching upstream tags --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index f3673d012e..57459f1b05 100644 --- a/README.md +++ b/README.md @@ -102,6 +102,17 @@ To clone the scripts repo and pick a version: * 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` +### 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: * 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. From 3ca61e9cfc326b29d02f9b55690e291c18dab46c Mon Sep 17 00:00:00 2001 From: Jan Bronicki Date: Fri, 6 Jun 2025 16:36:10 +0200 Subject: [PATCH 2/4] Update README.md Co-authored-by: Thilo Fromm --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 57459f1b05..b84522b5b4 100644 --- a/README.md +++ b/README.md @@ -104,6 +104,9 @@ To clone the scripts repo and pick a version: ### Working with forks +When using GitHub's "fork" feature, please **make sure to fork all branches**, not just `main`. Forking only `main` is the default on GitHub, + +The SDK container wrapper script `run_sdk_container` requires release tags in our release branches and fails to start if no release branch is present (see e.g. https://github.com/flatcar/Flatcar/issues/1705). 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 From 0c1df6202083ce86e7c2da2b4a205f3550a7274e Mon Sep 17 00:00:00 2001 From: Jan Bronicki Date: Fri, 6 Jun 2025 16:36:55 +0200 Subject: [PATCH 3/4] Update README.md Co-authored-by: Thilo Fromm --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b84522b5b4..b72b75d5e1 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,7 @@ To clone the scripts repo and pick a version: When using GitHub's "fork" feature, please **make sure to fork all branches**, not just `main`. Forking only `main` is the default on GitHub, The SDK container wrapper script `run_sdk_container` requires release tags in our release branches and fails to start if no release branch is present (see e.g. https://github.com/flatcar/Flatcar/issues/1705). -If you're working with a fork of the scripts repository, you'll need to fetch the upstream tags to avoid version detection issues: +If you have forked manually, please make sure to include all tags. You can retrofit upstream tags to a fork by using e.g.: ```bash git remote add upstream https://github.com/flatcar/scripts.git From 30abd79aaf8252f9f1284fbd3ee89c93b3055618 Mon Sep 17 00:00:00 2001 From: Thilo Fromm Date: Fri, 6 Jun 2025 16:41:10 +0200 Subject: [PATCH 4/4] Update README.md Co-authored-by: Mathieu Tortuyaux --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b72b75d5e1..66f321c255 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ To clone the scripts repo and pick a version: ### Working with forks -When using GitHub's "fork" feature, please **make sure to fork all branches**, not just `main`. Forking only `main` is the default on GitHub, +When using GitHub's "fork" feature, please **make sure to fork all branches**, not just `main`. Forking only `main` is the default on GitHub. The SDK container wrapper script `run_sdk_container` requires release tags in our release branches and fails to start if no release branch is present (see e.g. https://github.com/flatcar/Flatcar/issues/1705). If you have forked manually, please make sure to include all tags. You can retrofit upstream tags to a fork by using e.g.: