Github Action

This is a Github Action used to update Mod information and Mod files in the MOD site.

Action Update Mod

[![github][github-badge]][github-link] [![test][test-badge]][test-link]![license][license-badge] [![version][release-badge]][release-link] [![market][market-badge]][market-link] [![-badge]][-link]

Introduction

This is a Github Action used to update Mod information and Mod files in the MOD site.

If your Mod source code is hosted on Github, you can use this Github Action to automate your Mod update process.

You can set it to automatically upload the latest version of the Release file to the Mod Station when publishing a Release on Github, and you can also update various information about the Mod.

You can refer to the API documentation for details.

Since the original project was written in Python, it can only run in the Linux environment due to Github restrictions. Now this can run in any environment.

Sample Workflow file

```yaml

name: Release

on:

release:

types: [published] #Triggered when a Release is published

jobs:

release:

runs-on: ubuntu-latest #or windows-latest

steps:

• uses: actions/checkout@v3

• name: Update Mod site information

uses: GlossMod/ActionUpdateMod@v1

with:

appid: ${{ secrets.APPID }} #Call the APPID stored in github secrets

appkey: ${{ secrets.APPKEY }} #Call APPKEY stored in github secrets

id: 548964

title: My Mod title

version: ${{ github.event.release.tag_name }} #Use the tag when publishing

desc: My Mod Introduction

content: README.md #You can enter the markdown file path, or directly enter the markdown code

file: build/windows/myMod.asi #You can enter the folder path or file path. If it is not in zip/rar/7z format, it will be automatically packaged.

```

Input parameters

| Input parameters | Description | Example |

| ------------------ | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |

| `appid` | APPID of Mod Site API | ${{ secrets.APPID }} |

| `appkey` | Mod Site API's APPKEY | ${{ secrets.APPKEY }} |

| `id` | The ID number of the Mod you want to update | 548964 |

| `title` (optional) | The title of the mod | My Mods |

| `tags` (optional) | Mod tags | Modifier, Chinese, original |

| `version` (optional) | Mod version number | v1.2.5 |

| `desc` (optional) | A brief description of the Mod | My super powerful modifier Mod |

| `content` (optional) | The Markdown file path or Markdown code of the Mod’s introduction text | README.md |

| `file` (optional) | Mod file path (size limit: 10mb), if the file path is not in `zip/rar/7z` format, it will be automatically packaged and uploaded (supports folder packaging)

If you need to upload files over 10mb, you can use Nats-ji/Action3DMLargeFileUpload to upload | `build/windows/x64/helloworld.asi`,

`package/mymod/` |

| `zip-only` (optional) | Pack only Mod files without uploading | false |

| `test` (optional) | Whether to test run without communicating with the API | false |

Notice

Do not enter your `appid` and `appkey` directly into your workflow file. You should store them in the secret of your project warehouse and use `${{ secrets.APPID }}`, `${{ secrets.APPKEY }}` and other calls.

Output

| Output | Description |

| ------ | ---------------- |

| `code` | status code |

| `msg` | Return message |

| `file` | Packaged file path |

How to use output

```yaml

steps:

• name: Update Mod site information

uses: GlossMod/ActionUpdateMod@v1

id: update_mod #Set the id of this step for the next step to call the output of this step

with:

appid: ${{ secrets.APPID }}

appkey: ${{ secrets.APPKEY }}

id: 548964

version: ${{ github.event.release.tag_name }}

content: README.md

file: build/windows/myMod.asi

• name: echo the output of the previous step

run: echo "The status code returned by the API: ${{ steps.update_mod.outputs.code }}, the returned message: ${{ steps.update_mod.outputs.msg }}"

```

contribute

Feel fre …