Fixes CI Badge in README.md (#164)

* Fixes CI Badge in README.md * Removes additional fetching from git * More work on the CI script * Adds requirements.txt for tools, fixes CI script even more --------- Co-authored-by: Felix "xq" Queißner <[email protected]>
ZigEmbeddedGroup · Feb 17, 2024 · 196bbd8 · 196bbd8
1 parent 829f860
commit 196bbd8
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 29 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -19,13 +19,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-tags: true # required for "git describe"
-
-      - name: Fetch more data from git
-        run: |
-          # fetch everything back till the $(ZIG_VERSION) tag.
-          # https://stackoverflow.com/a/58082274
-          git fetch --shallow-exclude ${{ env.ZIG_VERSION }}
-          git fetch --deepen=2
+          fetch-depth: 0
 
       - name: Setup Zig
         uses: goto-bus-stop/setup-zig@v2
@@ -34,7 +28,7 @@ jobs:
 
       - name: Install PIP packages
         run: |
-          pip install dataclasses_json==0.6.3 marshmallow typing-inspect semver pathspec
+          pip install -r tools/requirements.txt
 
       - name: Generate and validate packages
         run: |
@@ -53,13 +47,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-tags: true # required for "git describe"
-
-      - name: Fetch more data from git
-        run: |
-          # fetch everything back till the $(ZIG_VERSION) tag.
-          # https://stackoverflow.com/a/58082274
-          git fetch --shallow-exclude ${{ env.ZIG_VERSION }}
-          git fetch --deepen=2
+          fetch-depth: 0
 
       - name: Setup Zig
         uses: goto-bus-stop/setup-zig@v2
@@ -68,7 +56,7 @@ jobs:
 
       - name: Install PIP packages
         run: |
-          pip install dataclasses_json==0.6.3 marshmallow typing-inspect semver pathspec
+          pip install -r tools/requirements.txt
 
       - name: Generate packages
         run: |

diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -16,13 +16,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-tags: true # required for "git describe"
-
-      - name: Fetch more data from git
-        run: |
-          # fetch everything back till the $(ZIG_VERSION) tag.
-          # https://stackoverflow.com/a/58082274
-          git fetch --shallow-exclude ${{ env.ZIG_VERSION }}
-          git fetch --deepen=2
+          fetch-depth: 0
 
       - name: Setup Zig
         uses: goto-bus-stop/setup-zig@v2
@@ -31,7 +25,7 @@ jobs:
 
       - name: Install PIP packages
         run: |
-          pip install dataclasses_json==0.6.3 marshmallow typing-inspect semver pathspec
+          pip install -r tools/requirements.txt
 
       - name: Generate and validate packages
         run: |

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![Chat](https://img.shields.io/discord/824493524413710336.svg?logo=discord)](link=https://discord.gg/ShUWykk38X)
 [![Downloads](https://img.shields.io/badge/Zig_Package-Download-blue)](https://downloads.microzig.tech/)
-[![Continuous Integration](https://github.com/ZigEmbeddedGroup/microzig-monorepo/actions/workflows/build.yml/badge.svg)](https://github.com/ZigEmbeddedGroup/microzig-monorepo/actions/workflows/build.yml)
+[![Continuous Integration](https://github.com/ZigEmbeddedGroup/microzig/actions/workflows/build.yml/badge.svg)](https://github.com/ZigEmbeddedGroup/microzig/actions/workflows/build.yml)
 
 > **NOTE:** This is in development; breaks in the API are bound to happen.
 

diff --git a/tools/bundle.py b/tools/bundle.py
@@ -38,6 +38,7 @@
     "zig",
     "git",
 ]
+REQUIRED_ZIG_VERSION="0.11.0"
 
 
 REPO_ROOT = Path(__file__).parent.parent
@@ -168,7 +169,10 @@ def build_zig_tools():
 # Determines the correct version:
 def get_version_from_git() -> str:
 
-    raw_git_out = slurp("git", "describe", "--match", "*.*.*", "--tags", "--abbrev=9", cwd=REPO_ROOT).strip().decode()
+    raw_git_out = slurp("git", "describe", "--match", "*.*.*", "--tags", "--abbrev=9", cwd=REPO_ROOT, allow_failure=True).strip().decode()
+    if len(raw_git_out) == 0:
+        print("failed to get version from git, using 'development'", file=sys.stderr)
+        return f"{REQUIRED_ZIG_VERSION}-development"
 
     def render_version(major,minor,patch,counter,hash):
         return f"{major}.{minor}.{patch}-{counter}-{hash}"
@@ -251,7 +255,7 @@ def main():
 
     check_required_tools(REQUIRED_TOOLS)
 
-    check_zig_version("0.11.0")
+    check_zig_version(REQUIRED_ZIG_VERSION)
 
     print("preparing environment...")
 

diff --git a/tools/lib/common.py b/tools/lib/common.py
@@ -3,14 +3,14 @@
 
 VERBOSE = False
 
-def execute_raw(*args,hide_stderr = False,**kwargs):
+def execute_raw(*args,hide_stderr: bool = False, allow_failure: bool = False, **kwargs):
     args = [ str(f) for f in args]
     if VERBOSE:
         print(*args)
     res = subprocess.run(args, **kwargs, check=False)
     if res.stderr is not None and (not hide_stderr or res.returncode != 0):
         sys.stderr.buffer.write(res.stderr)
-    if res.returncode != 0:
+    if not allow_failure and res.returncode != 0:
         sys.stderr.write(f"command {' '.join(args)} failed with exit code {res.returncode}")
         sys.exit(res.returncode)
     return res 

diff --git a/tools/requirements.txt b/tools/requirements.txt
@@ -0,0 +1,5 @@
+dataclasses_json==0.6.3
+marshmallow
+typing-inspect
+semver
+pathspec