ci with BnP enabled

Author: mbakalarski

.github/workflows/ci.yml

@@ -1,50 +1,35 @@
 name: CI
 
-# on:
-#   push:
-#     branches:
-#       - main
-#       - release-*
-#   pull_request: {}
-#   workflow_dispatch:
-#     inputs:
-#       version:
-#         description: Package version (e.g. v0.1.0)
-#         required: false
+on:
+  push:
+    branches:
+      - main
+      - release-*
+    tags:
+      - v*
+  pull_request: {}
 
 env:
-  # Common versions
-  PYTHON_VERSION: '3.11'
-  HATCH_VERSION: '1.12.0'
-  DOCKER_BUILDX_VERSION: 'v0.24.0'
+  PYTHON_VERSION: "3.11"
+  HATCH_VERSION: "1.16.2"
+  DOCKER_BUILDX_VERSION: "v0.30.1"
 
-  # These environment variables are important to the Crossplane CLI install.sh
-  # script. They determine what version it installs.
   XP_CHANNEL: stable
-  XP_VERSION: v1.20.0
-
-  # The package to push, without a version tag. The default matches GitHub. For
-  # example xpkg.crossplane.io/crossplane/function-template-go. Note that
-  # xpkg.crossplane.io is just an alias for ghcr.io, so we upload to ghcr.io but
-  # this'll be pulled from xpkg.crossplane.io.
-  XPKG: ghcr.io/${{ github.repository}}
+  # XP_VERSION: v2.1.3 # the latest stable Crossplane CLI will be used
 
-  # The package version to push. The default is 0.0.0-gitsha.
-  XPKG_VERSION: ${{ inputs.version }}
+  XPKG: xpkg.crossplane.io/${{ github.repository }}
 
 jobs:
   lint:
     runs-on: ubuntu-24.04
     steps:
-      - name: Checkout
-        uses: actions/checkout@v6
+      - uses: actions/checkout@v6
 
-      - name: Setup Python
-        uses: actions/setup-python@v6
+      - uses: actions/setup-python@v6
         with:
           python-version: ${{ env.PYTHON_VERSION }}
 
-      - name: Setup Hatch
+      - name: Install Hatch
         run: pipx install hatch==${{ env.HATCH_VERSION }}
 
       - name: Lint
@@ -53,32 +38,30 @@ jobs:
   unit-test:
     runs-on: ubuntu-24.04
     steps:
-      - name: Checkout
-        uses: actions/checkout@v6
+      - uses: actions/checkout@v6
 
-      - name: Setup Python
-        uses: actions/setup-python@v6
+      - uses: actions/setup-python@v6
         with:
           python-version: ${{ env.PYTHON_VERSION }}
 
-      - name: Setup Hatch
+      - name: Install Hatch
         run: pipx install hatch==${{ env.HATCH_VERSION }}
 
-      - name: Run Unit Tests
+      - name: Run unit tests
         run: hatch test --all --randomize
 
-  # We want to build most packages for the amd64 and arm64 architectures. To
-  # speed this up we build single-platform packages in parallel. We then upload
-  # those packages to GitHub as a build artifact. The push job downloads those
-  # artifacts and pushes them as a single multi-platform package. 
   build:
     runs-on: ubuntu-24.04
+    needs:
+      - lint
+      - unit-test
     strategy:
       fail-fast: true
       matrix:
         arch:
           - amd64
           - arm64
+
     steps:
       - name: Setup QEMU
         uses: docker/setup-qemu-action@v3
@@ -91,59 +74,68 @@ jobs:
           version: ${{ env.DOCKER_BUILDX_VERSION }}
           install: true
 
-      - name: Checkout
-        uses: actions/checkout@v6
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Read version from Python package
+        run: |
+          echo "XPKG_VERSION=v$(python -c 'from function.__version__ import __version__; print(__version__)')" >> $GITHUB_ENV
 
-      # We ask Docker to use GitHub Action's native caching support to speed up
-      # the build, per https://docs.docker.com/build/cache/backends/gha/.
-      - name: Build Runtime
-        id: image
+      - name: Build runtime image
         uses: docker/build-push-action@v6
         with:
           context: .
           platforms: linux/${{ matrix.arch }}
+          target: image
           cache-from: type=gha
           cache-to: type=gha,mode=max
-          target: image
           build-args:
             PYTHON_VERSION=${{ env.PYTHON_VERSION }}
           outputs: type=docker,dest=runtime-${{ matrix.arch }}.tar
-      
-      - name: Setup the Crossplane CLI
-        run: "curl -sL https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh | sh"
-
-      - name: Build Package
-        run: ./crossplane xpkg build --package-file=${{ matrix.arch }}.xpkg --package-root=package/ --embed-runtime-image-tarball=runtime-${{ matrix.arch }}.tar
-      
-      - name: Upload Single-Platform Package
+
+      - name: Install Crossplane CLI
+        run: |
+          curl -sL https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh | sh
+
+      - name: Build xpkg
+        run: |
+          ./crossplane xpkg build \
+            --package-root=package \
+            --package-file=${{ matrix.arch }}.xpkg \
+            --embed-runtime-image-tarball=runtime-${{ matrix.arch }}.tar
+
+      - name: Upload package artifact
         uses: actions/upload-artifact@v6
         with:
           name: package-${{ matrix.arch }}
           path: "*.xpkg"
-          if-no-files-found: error
           retention-days: 1
 
-  # This job downloads the single-platform packages built by the build job, and
-  # pushes them as a multi-platform package.
   push:
-    if: ${{ github.event_name != 'pull_request' }}
+    if: github.event_name != 'pull_request'
     runs-on: ubuntu-24.04
     needs:
       - build
+
     steps:
-      - name: Checkout
-        uses: actions/checkout@v6
+      - uses: actions/checkout@v6
 
-      - name: Download Single-Platform Packages
+      - name: Download artifacts
         uses: actions/download-artifact@v7
         with:
-          # See https://github.com/docker/build-push-action/blob/263435/README.md#summaries
-          pattern: "!*.dockerbuild"
           path: .
           merge-multiple: true
 
-      - name: Setup the Crossplane CLI
-        run: "curl -sL https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh | sh"
+      - name: Install Crossplane CLI
+        run: |
+          curl -sL https://raw.githubusercontent.com/crossplane/crossplane/master/install.sh | sh
+
+      - name: Read version from Python package
+        run: |
+          echo "XPKG_VERSION=v$(python -c 'from function.__version__ import __version__; print(__version__)')" >> $GITHUB_ENV
 
       - name: Login to GitHub Container Registry
         uses: docker/login-action@v3
@@ -152,13 +144,8 @@ jobs:
           username: ${{ github.repository_owner }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      # If a version wasn't explicitly passed as a workflow_dispatch input we
-      # default to version v0.0.0-<git-commit-date>-<git-short-sha>, for example
-      # v0.0.0-20231101115142-1091066df799. This is a simple implementation of
-      # Go's pseudo-versions: https://go.dev/ref/mod#pseudo-versions.
-      - name: Set Default Multi-Platform Package Version
-        if: env.XPKG_VERSION == ''
-        run: echo "XPKG_VERSION=v0.0.0-$(date -d@$(git show -s --format=%ct) +%Y%m%d%H%M%S)-$(git rev-parse --short=12 HEAD)" >> $GITHUB_ENV
-
-      - name: Push Multi-Platform Package to GitHub Container Registry
-        run: "./crossplane --verbose xpkg push --package-files $(echo *.xpkg|tr ' ' ,) ${{ env.XPKG }}:${{ env.XPKG_VERSION }}"
+      - name: Push multi-arch xpkg
+        run: |
+          ./crossplane --verbose xpkg push \
+            --package-files $(echo *.xpkg | tr ' ' ,) \
+            ${{ env.XPKG }}:${{ env.XPKG_VERSION }}

function/__version__.py

@@ -1,4 +1,5 @@
 # Copyright 2023 The Crossplane Authors.
+# Copyright 2025-present Michal Bakalarski and Netclab Contributors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,4 +16,4 @@
 """The version of the function."""
 
 # This is set at build time, using "hatch version"
-__version__ = "0.0.0"
+__version__ = "0.0.1"

function/fn.py

@@ -1,3 +1,18 @@
+# Copyright 2025-present Michal Bakalarski and Netclab Contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 """A Crossplane composition function."""
 
 import hashlib

pyproject.toml

@@ -9,7 +9,9 @@ readme = "README.md"
 requires-python = ">=3.11,<3.12"
 license = "Apache-2.0"
 keywords = []
-authors = [{ name = "Michal Bakalarski" }]
+authors = [
+  { name = "Michal Bakalarski", email = "64490638+mbakalarski@users.noreply.github.com" }
+]
 classifiers = [
   "Development Status :: 3 - Alpha",
   "Programming Language :: Python",

tests/test_fn.py

@@ -1,3 +1,18 @@
+# Copyright 2025-present Michal Bakalarski and Netclab Contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 import json
 import unittest