https://github.com/armory3d/armory_gh_actions

Build armory projects in github workflows
https://github.com/armory3d/armory_gh_actions

actions armory3d blender github-actions kha krom

Last synced: about 2 months ago
JSON representation

Build armory projects in github workflows

• Host: GitHub
• URL: https://github.com/armory3d/armory_gh_actions
• Owner: armory3d
• Created: 2021-09-23T07:59:14.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-11-26T01:00:17.000Z (about 2 years ago)
• Last Synced: 2024-10-31T10:43:56.555Z (2 months ago)
• Topics: actions, armory3d, blender, github-actions, kha, krom
• Language: TypeScript
• Homepage:
• Size: 410 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Armory3D Github Actions

=======================

This action sets up a [armory3d](https://armory3d.org/) environment to build projects in your github workflows.

# Usage

See [action.yml](action.yml)

## Inputs

| Name | Description | Required | Default |

| - | - | - | - |

| `blend` | Main blend file | Yes | |

| `build` | Build exporter name | No | The active [armory exporter](.github/exporter-presets.png) |

| `publish` | Publish exporter name | No | The active [armory exporter](.github/exporter-presets.png) |

| `blender` | Blender version ([snap](https://snapcraft.io/blender)) | No | `3.3lts/stable` |

| `armsdk_url` | URL of to the armsdk repository | No | `https://github.com/armory3d/armsdk`

| `armsdk_ref` | Named branch, tag, or SHA of the armsdk repository | No | `main`

Either `build` or `publish` must be given the name of an *exporter* preset defined in [`Render Properties - Armory Exporter`](exporter-presets.png). It can have any name, but is most likely named after the build target.

## Outputs

| Name | Description | Default |

| - | - | - |

| `code` | Exit code | |

| `time` | Duration ms | |

| `result` | stdout data |  |

| `error` | stderr  data |  |

---

See: [.github/workflows/empty-project.yml](.github/workflows/empty-project.yml)

### Publish project

```yaml

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v3

      - name: Publish

        uses: armory3d/[email protected]

        with:

          blend: awesome.blend # Main blend file

          publish: html5 # Name of the armory exporter

```

### Custom blender, armsdk version

```yaml

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v3

      - name: Publish

        uses: armory3d/[email protected]

          with:

            blend: awesome.blend # Main blend file

            publish: linux # Name of the armory exporter

            blender: latest/candidate  # Blender snap package version

            armsdk_ref: 22.09 # Armsdk version

```

### Cache armsdk to speedup builds, print build results

```yaml

jobs:

  build:

    runs-on: ubuntu-latest

    env:

      armsdk_version: 22.09

    steps:

      - uses: actions/checkout@v3

      - name: Cache armsdk

        uses: actions/cache@v2

        env:

          armsdk-cache-version: ${{ env.armsdk_version }}

        with:

          path: _armsdk_

          key: armsdk-cache-${{ env.armsdk-cache-version }}

      - name: Build

        id: awesome

        uses: armory3d/[email protected]

        with:

          blend: awesome.blend

          publish: html5

          armsdk_ref: ${{ env.armsdk_version }}

      - name: Result

        run: |

          echo "Code: ${{ steps.awesome.outputs.code }}"

          echo "Time: ${{ steps.awesome.outputs.time }}"

```

---

[![test](https://github.com/armory3d/armory_gh_actions/actions/workflows/test.yml/badge.svg)](https://github.com/armory3d/armory_gh_actions/actions/workflows/test.yml)