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

ModRelease - create new Github Release from commandline

$
0
0
Hi,

Script for creating new Github Release from commandline

Features:
  • cross-platform, single code for Windows, macOS, and Linux
  • release version (tag) is taken directly from tp2 file
  • 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 a new release
  • initial release description is generated from commit messages between the new release and previous release

Prerequisites:
Requirements:
Installation:
  1. Download and extract ModRelease 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 your 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 the top-level directory of the mod's cloned Github repository, it's where WeiDU executable should be, use the included mod example as reference.

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

prz2z60ja0wg.png

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


Feedback/questions/comments are welcomed.

Viewing all articles
Browse latest Browse all 11774

Latest Images

Trending Articles



Latest Images