From fd1199a91ded385764edc3fa6e023846d2ab97a3 Mon Sep 17 00:00:00 2001 From: Avery Wagar Date: Mon, 26 Jul 2021 02:27:22 -0700 Subject: [PATCH 1/2] Describe Github Actions --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index 0df0b7d..f41f453 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,44 @@ Sign your PBOs with `laat pack --sign` or `laat sign` Release to the Steam workshop with `laat release -u -p -g ` +### GitHub Actions + +Since LAAT, by-default, doesn't require any extra tooling, you can run it in GitHub actions and automatically build and release your mod to the Steam Workshop. + +```yml +name: Build and Release with LAAT + +on: + # Triggers the workflow on push or pull request events but only for the master branch + push: + branches: [ master ] + pull_request: + branches: [ master ] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + + +jobs: + build: + runs-on: ubuntu-latest + + steps: + # Checks-out your repository + - uses: actions/checkout@v2 + + # Build, Pack, and Sign using LAAT + - uses: ajmwagar/laat@v1.1 + with: + command: ship + + # Release the mod to the Steam Workshop + - uses: ajmwagar/laat@v1.1 + with: + command: release + args: -u ${{ secrets.STEAM_USER }} -p ${{ secrets.STEAM_PASS }} --no-change-log +``` + ## Configuration Currently you configure the bulk of LAAT via the `LAAT.toml` file. From 3edfc6927f218cdc7f74ec17b7e8c842049c6eb3 Mon Sep 17 00:00:00 2001 From: Avery Wagar Date: Mon, 26 Jul 2021 02:43:18 -0700 Subject: [PATCH 2/2] Update README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index f41f453..77c1001 100644 --- a/README.md +++ b/README.md @@ -132,6 +132,25 @@ A LAAT Project might look like the following: └── @17th ``` +## Developing with LAAT + +The development workflow with LAAT adds a new step. + +We call it the "build" step, which comes before PBO packing. + +Think of the "build" step as another developer who is working on the project with you. It will generate code and addons and add them to the `build` folder. + +--- + +The workflow for people who are building normal addons doesn't change, However, we have removed the P:/ drive. + +The steps in the pipeline are as follows: +- `build`: LAAT generates your addons +- `pack`: LAAT uses `armake2` to pack your addons into PBOs. +- `sign`: LAAT signs your PBOs using your `.biprivatekey` file. +- `release`: LAAT used `steamcmd` to upload your mod to the Steam Workshop. + + ## Compiler Plugins Plugins are what take your assets and configuration file, and turn them into valid Arma 3 Mod Addons (i.e. the things you build into PBOs)