Merge pull request #3 from lightbug-io/ci

CI LB attempt

Author: addshore

.github/workflows/ci.yml

@@ -10,11 +10,16 @@ on:
 
 jobs:
   build:
+    permissions:
+      contents: write
     strategy:
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        variant:
+          - esp32c6-standard
+          - esp32c6-large-partitions
+          - esp32c6-single-ota
 
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
@@ -27,26 +32,21 @@ jobs:
           toit-dir: toit
           esp32: true
 
-      - shell: bash
-        run: echo $PATH
-
-      - name: Build - Linux and macOS
-        if: runner.os != 'Windows'
+      - name: Build envelope
         shell: bash
         run: |
-          make init  # Can be removed once the project is set up.
-          make
+          make init
+          make envelope VARIANT=${{ matrix.variant }}
 
-      - name: Build - Windows
-        if: runner.os == 'Windows'
-        shell: pwsh
-        run: |
-          make init  # Can be removed once the project is set up.
-          ${{ github.workspace }}/toit/third_party/esp-idf/export.ps1
-          make host
-          cmake -E env `
-               "IDF_PATH=$PWD/toit/third_party/esp-idf" `
-               "IDF_TARGET=esp32" "IDF_CCACHE_ENABLE=1" `
-               "TOIT_EXTRA_COMPONENTS=$PWD/components" `
-               "TOIT_SDK_DIR=$PWD/build/host/sdk" `
-               python $PWD/toit/third_party/esp-idf/tools/idf.py -B "$PWD/build/esp32" -C build-root build
+      - name: Upload envelope artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: envelope-${{ matrix.variant }}.envelope
+          path: dist/${{ matrix.variant }}.envelope
+
+      - name: Publish GitHub release asset
+        if: github.ref_type == 'tag'
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            dist/${{ matrix.variant }}.envelope

.gitignore

@@ -1,3 +1,31 @@
 .packages/
 /build/
+/dist/
+/build-root/sdkconfig
 /build-root/sdkconfig.old
+
+# Editor / IDE
+.vscode/
+*.swp
+.DS_Store
+
+# Build artifacts
+build-root/build/
+build/
+*.o
+*.elf
+*.bin
+*.map
+
+# Generated config / board files
+build-root/partitions.csv
+build-root/sdkconfig.defaults
+*.config
+
+# Python
+__pycache__/
+*.pyc
+
+# Environment / secrets
+.env
+

Makefile

@@ -8,7 +8,11 @@ SHELL := bash
 
 # Change to your configuration. See toit/toolchains for the available targets.
 # Then run 'make init'.
-IDF_TARGET := esp32
+IDF_TARGET := esp32c6
+
+# Envelope variants.
+VARIANT ?= esp32c6-standard
+VARIANTS ?= esp32c6-standard esp32c6-large-partitions esp32c6-single-ota
 
 # Set to false to avoid initializing submodules at every build.
 INITIALIZE_SUBMODULES := true
@@ -19,11 +23,12 @@ COMPONENTS := $(SOURCE_DIR)/components
 # Constants that typically don't need to be changed.
 BUILD_ROOT := $(SOURCE_DIR)/build-root
 BUILD_PATH := $(SOURCE_DIR)/build
+DIST_DIR := $(SOURCE_DIR)/dist
 TOIT_ROOT := $(SOURCE_DIR)/toit
 IDF_PATH := $(TOIT_ROOT)/third_party/esp-idf
 IDF_PY := $(IDF_PATH)/tools/idf.py
 
-all: esp32
+all: envelope
 
 define toit-make
 	@$(MAKE) -C "$(BUILD_ROOT)" \
@@ -52,11 +57,49 @@ build-host: host
 
 .PHONY: esp32
 esp32: initialize-submodules
-	@if [[ ! -f $(BUILD_ROOT)/sdkconfig.defaults ]]; then \
+	@$(MAKE) envelope VARIANT=$(VARIANT)
+
+.PHONY: list-variants
+list-variants:
+	@printf "%s\n" $(VARIANTS)
+
+.PHONY: envelope
+envelope: initialize-submodules
+	@if [[ ! -f "$(BUILD_ROOT)/sdkconfig.defaults" || ! -f "$(BUILD_ROOT)/partitions.csv" ]]; then \
 	  echo "Run 'make init' first"; \
-		exit 1; \
+	  exit 1; \
+	fi
+	@if [[ ! -f "$(SOURCE_DIR)/variants/$(VARIANT)/partitions.csv" ]]; then \
+	  echo "Unknown VARIANT: $(VARIANT)"; \
+	  echo "Known variants:"; \
+	  $(MAKE) list-variants; \
+	  exit 1; \
 	fi
-	@$(call toit-make,esp32)
+	@mkdir -p "$(DIST_DIR)"
+	@tmp_part=$$(mktemp); \
+	  cp "$(BUILD_ROOT)/partitions.csv" "$$tmp_part"; \
+	  cp "$(SOURCE_DIR)/variants/$(VARIANT)/partitions.csv" "$(BUILD_ROOT)/partitions.csv"; \
+	  $(MAKE) -C "$(BUILD_ROOT)" \
+	    COMPONENTS=$(COMPONENTS) \
+	    BUILD_PATH=$(BUILD_PATH)/variants/$(VARIANT) \
+	    BASE_BUILD_PATH=$(BUILD_PATH) \
+	    TOIT_ROOT=$(TOIT_ROOT) \
+	    IDF_TARGET=$(IDF_TARGET) \
+	    IDF_PATH=$(IDF_PATH) \
+	    IDF_PY=$(IDF_PY) \
+	    esp32; \
+	  status=$$?; \
+	  if [[ $$status -eq 0 ]]; then \
+	    cp "$(BUILD_PATH)/variants/$(VARIANT)/$(IDF_TARGET)/firmware.envelope" "$(DIST_DIR)/$(VARIANT).envelope"; \
+	  fi; \
+	  mv "$$tmp_part" "$(BUILD_ROOT)/partitions.csv"; \
+	  exit $$status
+
+.PHONY: envelopes
+envelopes: initialize-submodules
+	@for v in $(VARIANTS); do \
+	  $(MAKE) envelope VARIANT=$$v; \
+	done
 
 .PHONY: menuconfig
 menuconfig: initialize-submodules

README-external-service.md

@@ -1,14 +1,14 @@
-# Template repository for creating a custom Toit envelope
+# Lightbug custom Toit envelopes
 
-This repository can be used to create custom [envelopes](https://docs.toit.io/tutorials/containers)
-for [Toit](https://toitlang.org/).
+This repository creates custom [envelopes](https://docs.toit.io/tutorials/containers)
+for [Toit](https://toitlang.org/) use with Lightbug devices, and is based on [this template repository](https://github.com/toitlang/template-custom-envelope).
 
-There are already many [pre-built envelopes](https://github.com/toitlang/envelopes) available, but
-if you need to create a custom envelope, this repository can be used as a starting point.
+## Releases
 
-## External services
+You can find released envelopes under the Github releases page: https://github.com/lightbug-io/toit-envelopes/releases
 
-See the [README-external-service.md](README-external-service.md) file for information on how to use external services.
+Tags should have the format "v2.0.0-alpha.189.lb.yyymmdd".
+In the case that multiple releases are made on the same day, the "yyyymmdd" part can be extended with a suffix, e.g. "yyyymmdd-1", "yyyymmdd-2", etc.
 
 ## Setup
 
@@ -18,8 +18,9 @@ See the [README-external-service.md](README-external-service.md) file for inform
   - https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html
   - A good starting point is to run `install.sh` from the `toit/third_party/esp-idf` folder.
 
-The [ci.yml](.github/workflows/ci.yml) file uses Toit's setup action to install all prerequisites
-on a GitHub runner. You can use this as a reference for setting up your own environment.
+The [ci.yml](.github/workflows/ci.yml) file uses Toit's setup action to install all prerequisites on a GitHub runner.
+
+This CI action will build artifacts on every push, as well as create release artifacts on every tag.
 
 ### Initial setup
 
@@ -59,7 +60,7 @@ on a GitHub runner. You can use this as a reference for setting up your own envi
   ```
 
 * Change the license to your license.
-* Change the `TARGET` variable in the Makefile to the name of your chip. By default it is set to `esp32`.
+* Change the `IDF_TARGET` variable in the Makefile to the name of your chip.
 * Run `make init`. This will copy some of the Toit files, depending on the target, to your repository.
 
 After initialization you should have the files `sdkconfig.defaults` and `partitions.csv` in the `build-root`
@@ -73,11 +74,32 @@ checked into your repository.
   to compile on Windows or macOS.
 
 ### Build
-* Run `make` to build the envelope. It should end up with a `build/esp32/firmware.envelope`.
+This repository is set up to build multiple envelope variants.
+
+* Build one envelope variant:
+
+  ``` shell
+  make init
+  make envelope VARIANT=esp32c6-standard
+  ```
+
+  The resulting envelope is written to `dist/esp32c6-standard.envelope`.
+
+* Build all variants:
+
+  ``` shell
+  make init
+  make envelopes
+  ```
+
+  All resulting envelopes are written to `dist/*.envelope`.
 
 ## Makefile targets
-- `make` or `make all` - Build the envelope.
+- `make` or `make all` - Build the default envelope variant.
 - `make init` - Initialize after cloning. See the Setup section above.
 - `make menuconfig` - Runs the ESP-IDF menuconfig tool in the build-root. Also creates the `sdkconfig.defaults` file.
 - `make diff` - Show the differences between your configuration (sdkconfig and partitions.csv) and the default Toit configuration.
 - `make clean` - Remove all build artifacts.
+- `make envelope VARIANT=<name>` - Build one variant and write `dist/<name>.envelope`.
+- `make envelopes` - Build all variants.
+- `make list-variants` - Print the known variants.