Quantcast
Channel: Modding — Beamdog Forums
Viewing all articles
Browse latest Browse all 11774

ModRelease - create new Github Release with mod packages

$
0
0
Hi,

Script for creating new Github Release with mod packages.

Features:
  • cross-platform, single code for Windows, macOS and Linux
  • automatic creation of the .iemod/.zip packages as release assets
  • checking of the mod "VERSION" keyword, prevent creating "2.0.0" release when you mod version is "1.8.0"
  • prevent creating new release if the same release already exist
  • prevent creating new release if there are uncommitted file modifications
  • release description can be edited before creating new release
  • initial release description is generated from commit messages between the new release and previous release

Requirements:

Installation:

Reference of the proper folder structure:
Red - ModRelease folder and #ModRelease.bat/#ModRelease.command files location
Yellow - Repository top-level folder
Green - .git folder location inside mod cloned repository

prz2z60ja0wg.png

Download: https://github.com/InfinityMods/ModRelease/archive/master.zip
  1. Download and extract this repository, move everything from 'ModRelease-master' folder directly into the folder where you keep all cloned top-level mod folders.
  2. Create new "Personal Access Token" with "public_repo" privilege, it's not you password, you can revoke it at any time, more info here.
  3. Save it to "#ModRelease-Github-Key-Example.txt" file and rename it to #ModRelease-Github-Key.txt
  4. Put #ModRelease.bat/#ModRelease.command inside top-level directory of the mod's cloned Github repository, it's where WeiDU executable should be, use the included mod example as reference.

Usage:
  1. Assuming that all mod files are ready for new release, increase mod version inside mod readme and mod tp2 file.
  2. Create new commit with all modified files. Do not create new tag for release, it will be created automatically as 'mod version' and pushed into online repository.
  3. Run #ModRelease.bat (Windows) | #ModRelease.command (Mac) | #ModRelease.sh (Linux) and follow further instructions.

    Note: The ModID-Version.iemod and ModID-Version.zip packages will be created automatically and added as release assets.

Feedback/questions/comments are welcomed.

Viewing all articles
Browse latest Browse all 11774

Latest Images

Trending Articles



Latest Images