https://github.com/dosmike/spsauce-ghaction

GitHub action simplifying running SPSacue build scripts in your workflow
https://github.com/dosmike/spsauce-ghaction

Last synced: about 1 month ago
JSON representation

GitHub action simplifying running SPSacue build scripts in your workflow

• Host: GitHub
• URL: https://github.com/dosmike/spsauce-ghaction
• Owner: DosMike
• License: mit
• Created: 2022-05-12T14:59:02.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-02-14T22:07:50.000Z (almost 2 years ago)
• Last Synced: 2024-04-17T22:08:48.178Z (8 months ago)
• Language: Dockerfile
• Size: 404 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SPSauce Build

GitHub Action simplifying compiling and releasing [SourceMod](https://www.sourcemod.net/) plugins by running 

[SPSacue](https://github.com/DosMike/SPSauce/) build scripts in your workflow.

## Usage

Allows you to run a SPSauce build script. Set up to take the same arg string as the wrapper

described in the [SPSauce repo](https://github.com/DosMike/SPSauce). See this example:

*.github\workflows\github-release-build.yml*

```yml

name: Plugin Release Archive

on:

  release:

    types: [published]

jobs:

  pack-plugin:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@v3

      - name: SPSauce

        uses: DosMike/[email protected]

        with:

          script: ''

          github-token: ${{ github.token }}

          args: ''

```

*git.sauce*

```spsauce

sourcemod 1.11

auth github ${GITHUB_TOKEN}

spcomp -O2 myplugin.sp

with files

 myplugin.games.txt

 myplugin.smx

:release github ${GITHUB_REPOSITORY} ${GITHUB_REF_NAME}

```

## Notes

* You need the checkout step to get your repository into the action docker container.   

You could clone it by hand, but the actions is making it a lot easier.

* The build script is optional and relative to your repo root. It will use `git.sauce` by default.

* Just copy-paste the github-token line if you don't know what this does.

* For additional arguments to SPS, please check the SPSauce repo. This argument is optional.