{"id":20160605,"url":"https://github.com/zmkfirmware/zephyr-west-action","last_synced_at":"2025-10-29T00:01:46.356Z","repository":{"id":65162464,"uuid":"270876326","full_name":"zmkfirmware/zephyr-west-action","owner":"zmkfirmware","description":"A GitHub Action for working with Zephyr RTOS with the west build tool","archived":false,"fork":false,"pushed_at":"2020-12-31T16:33:18.000Z","size":20,"stargazers_count":7,"open_issues_count":1,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-04-14T07:39:22.796Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zmkfirmware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-06-09T01:42:19.000Z","updated_at":"2022-02-26T00:17:33.000Z","dependencies_parsed_at":"2023-01-04T12:39:08.233Z","dependency_job_id":null,"html_url":"https://github.com/zmkfirmware/zephyr-west-action","commit_stats":{"total_commits":18,"total_committers":1,"mean_commits":18.0,"dds":0.0,"last_synced_commit":"77f58da3536ae137dd945749ce9fb8aa77e755a8"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zmkfirmware%2Fzephyr-west-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zmkfirmware%2Fzephyr-west-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zmkfirmware%2Fzephyr-west-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zmkfirmware%2Fzephyr-west-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zmkfirmware","download_url":"https://codeload.github.com/zmkfirmware/zephyr-west-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241518042,"owners_count":19975366,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T00:14:55.904Z","updated_at":"2025-10-29T00:01:46.288Z","avatar_url":"https://github.com/zmkfirmware.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DEPRECATED\n\nNote, ZMK has deprecated using this, in favor of https://github.com/zmkfirmware/zmk-docker/.\n\n# Zephyr West Github Action\n\nA GitHub Action to allow performing actions using the [west](https://docs.zephyrproject.org/latest/guides/west/index.html) build tool.\n\nThe action includes the necessary SDK and dependencies to perform builds of [Zephyr RTOS](https://zephyrproject.org/) applications as well.\n\n## Directory Layout Requirement\n\nIn order to properly have the full West workspace be contained within the GitHub Actions workspace, this action requires\nthat the Zephyr application itself be in a toplevel subdirectory of the GitHub repository, e.g. under `app/`.\n\n## Inputs\n\n### command\n\nThe west command to run, e.g. `init` or `build`.\n\n### command-args\n\nExtra parameters/arguments to pass to the west command.\n\n# Example\n\nThe following example assumes a git repository with the Zephyr application\nplaced in the `app/` subdirectory, and demonstrates initalizing, updating, and\nthen building the application using west. This also includes caching of the\nkey module directories that are created in the workspace by west:\n\n```yaml\njobs:\n  build:\n    runs-on: ubuntu-latest\n    name: Build Test\n    steps:\n      # To use this repository's private action,\n      # you must check out the repository\n      - name: Checkout\n        uses: actions/checkout@v2\n      - name: Cache west modules\n        uses: actions/cache@v2\n        env:\n          cache-name: cache-zephyr-modules\n        with:\n          path: |\n            modules/\n            tools/\n            zephyr/\n            bootloader/\n          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('app/west.yml') }}\n          restore-keys: |\n            ${{ runner.os }}-build-${{ env.cache-name }}-\n            ${{ runner.os }}-build-\n            ${{ runner.os }}-\n      - name: West Init\n        uses: zmkfirmware/zephyr-west-action@v0.1.0\n        id: west-init\n        with:\n          command: 'init'\n          command-args: '-l app'\n      - name: West Update\n        uses: zmkfirmware/zephyr-west-action@v0.1.0\n        id: west-update\n        with:\n          command: 'update'\n      - name: West Config Zephyr Base\n        uses: zmkfirmware/zephyr-west-action@v0.1.0\n        id: west-config\n        with:\n          command: 'config'\n          command-args: '--global zephyr.base-prefer configfile'\n      - name: West Zephyr Export\n        uses: zmkfirmware/zephyr-west-action@v0.1.0\n        id: west-zephyr-export\n        with:\n          command: 'zephyr-export'\n      - name: West Build\n        uses: zmkfirmware/zephyr-west-action@v0.1.0\n        id: west-build\n        with:\n          command: 'build'\n          command-args: '-s app'\n```\n\n# Docker Container Version\n\nIn order to avoid rebuilding the GitHub Action each time your workflow runs, which currently\ntakes a significant amount of time, you can instead use the equivalent published images from\nDocker Hub in your workflows. There are two variants available:\n\n* `zmkfirmware/zephyr-west-action` - Includes the full Zephyr SDK, but is 1.3GB large.\n* `zmkfirmware/zephyr-west-action-arm` - Includes only the ARM toolchain, is lighter at 555MB.\n\nWhen using the Docker images, the `with` section needs only one parmeters, `args` which is passed\nto the docker `CMD` value at runtime. Any additional values to be passed to the west subcommand\nshould be surrounded by quotes (e.g. `build \"-b nucleo_wb55rg\"`).\n\n## Example\n\n```\njobs:\n  build:\n    runs-on: ubuntu-latest\n    name: Build Test\n    steps:\n      # To use this repository's private action,\n      # you must check out the repository\n      - name: Checkout\n        uses: actions/checkout@v2\n      - name: Cache west modules\n        uses: actions/cache@v2\n        env:\n          cache-name: cache-zephyr-modules\n        with:\n          path: |\n            modules/\n            tools/\n            zephyr/\n            bootloader/\n          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('app/west.yml') }}\n          restore-keys: |\n            ${{ runner.os }}-build-${{ env.cache-name }}-\n            ${{ runner.os }}-build-\n            ${{ runner.os }}-\n      - name: West Init\n        uses: 'docker://zmkfirmware/zephyr-west-action-arm:latest'\n        id: west-init\n        with:\n          args: 'init \"-l app\"'\n      - name: West Update\n        uses: 'docker://zmkfirmware/zephyr-west-action-arm:latest'\n        id: west-update\n        with:\n          args: 'update'\n      - name: West Config Zephyr Base\n        uses: 'docker://zmkfirmware/zephyr-west-action-arm:latest'\n        id: west-config\n        with:\n          args: 'config \"--global zephyr.base-prefer configfile\"'\n      - name: West Zephyr Export\n        uses: 'docker://zmkfirmware/zephyr-west-action-arm:latest'\n        id: west-zephyr-export\n        with:\n          args: 'zephyr-export'\n      - name: West Build\n        uses: 'docker://zmkfirmware/zephyr-west-action-arm:latest'\n        id: west-build\n        with:\n          args: 'build \"-s app\"'\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzmkfirmware%2Fzephyr-west-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzmkfirmware%2Fzephyr-west-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzmkfirmware%2Fzephyr-west-action/lists"}