Skip to content

InfinityMods/ModRelease

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

f35a126 · Jun 29, 2019

History

72 Commits
Jun 29, 2019
Jun 29, 2019
Jun 29, 2019
Jun 29, 2019

Repository files navigation

Script for creating new Github release with optional assets

Features:

  • prevent creating new release if the same release already exist
  • prevent creating new release if there are uncommitted file modifications
  • checking of the mod "VERSION" keyword, prevent creating '2.1.3' release when you mod version is '2.1.2'
  • release description can be edited before creating new release
  • initial release description is generated from commit messages between two latest tags

Requirements:

Windows 10 - Git
Windows 7/8.1 - Git, .NET Framework 4.5.2 or above and Powershell 5.1/Powershell 6
macOS - Git and Powershell 6
Linux - Git and Powershell 6

Installation:

  1. Download and extract this repository, move everything from 'ModRelease-master' folder directly into the folder where you keep all other top-level mod folders.

  2. Open https://github.com/settings/tokens, and create "personal access token" with "public_repo" privilege, it's not you password, you can revoke it at any time, more info: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line.

  3. Save it to "#ModRelease-Github-Key-Example.txt" file and rename it to #ModRelease-Github-Key.txt

  4. Put #ModRelease.bat inside mod top-level directory, use the included mod example as reference.

Usage:

  1. Increase mod version inside mod file.

  2. Create new commit. Do not create new tag for release, it will be created automatically from mod version and pushed into online repository.

    optional step: create mod packages (release assets), wait until all packages are created with proper names:

    ModID-version.exe
    ModID-version.iemod
    ModID-version.zip
    
  3. Run #ModRelease.bat and follow further instructions.