Create Release

Create Release#

workflow create-release#

Builds and packages a new version of mod. You can reference this workflow in your own repository on workflow-dispatch and have the developer type in a version number. Then it does the rest!

Note

This action DOES commit files to git (updated changelogs, version files, etc) so if you’re testing it out you should do it on a separate branch.

After running update-version, this workflow commits the changelog and version file changes and creates a new tag. Then it runs compile and assemble-release. And then finally it creates a draft github release with the packaged mod attached. For details:

Example usage from RasterPropMonitor

Example

- uses: KSPModdingLibs/KSPBuildTools/.github/workflows/create-release.yml@1.1.1

Inputs

input version-string#
Required:
True
Type:
string
input version-template-extension#
Default:
.versiontemplate
Type:
string
input version-template-files#
Type:
string
input build-configuration#
Default:
Release
Type:
string
input artifacts#
Default:
GameData LICENSE* README* CHANGELOG*
Type:
string
input ksp-zip-url#
Default:
https://github.com/KSPModdingLibs/KSPLibs/raw/main/KSP-1.12.5.zip
Type:
string
input dependency-identifiers#
Type:
string
input solution-file-path#
Type:
string
input use-msbuild#
Default:
True
Type:
boolean

If MSBuild should be used. If your mod has no msbuild project (e.g. a pure part mod) you should set this to false

input use-ckan#
Default:
False
Type:
boolean

If CKAN should be installed to install dependencies in the msbuild project.

input changelog-input-file#
Default:
CHANGELOG.md
Type:
string
input changelog-output-file#
Type:
string

Secrets

secret ksp-zip-password#
Required:
False
Contents