Skip to content

Latest commit

 

History

History
105 lines (100 loc) · 3.33 KB

README.md

File metadata and controls

105 lines (100 loc) · 3.33 KB
Raw

Workflow snippets for KSP-RO CI/CD

This repository contains reusable workflows and composite actions referenced in other KSP-RO projects.

Reusable workflows

Reusable workflows are stored in the .github/workflows folder. These are used at the jobs level.

check-secret.yml

Checks if the password for the assemblies needed to build the mods is present

To use the result of this job in another job, use this snippet at the top of that job:

needs: [check-secret] # name of the job using this workflow
if: needs.check-secret.outputs.has-password == 'true'
uses: KSP-RO/BuildTools/.github/workflows/check-secret.yml@master
secrets:
  # Github secret with password to the zip with assemblies
  # Required: true
  KSP_ZIP_PASSWORD: ''

validate-cfg-files.yml

Validates the cfg files using the KSPMMCfgParser by HebaruSan / CKAN

uses: KSP-RO/BuildTools/.github/workflows/validate-cfg-files.yml@master
with:
  # Path to file with list of cfg files to ignore while running the validator
  blacklist_path: ''

Composite actions

Composite actions are stored in separate folders. These are used at the steps level.

download-assemblies

Downloads assemblies for the build process

uses: KSP-RO/BuildTools/download-assemblies@master
with:
  # Github secret with password to the zip with assemblies
  # Required: true
  KSP_ZIP_PASSWORD: ''

download-assemblies-v2

Downloads assemblies for the build process using CKAN

uses: KSP-RO/BuildTools/download-assemblies-v2@master
with:
  # Github secret with password to the zip with KSP assemblies
  # Required: true
  KSP_ZIP_PASSWORD: ''
  # List of mods to install using CKAN
  # type: string
  dependency-identifiers:

process-changelog

Creates a kerbalConfig node from the release notes and pre-pends that to an existing config file

uses: KSP-RO/BuildTools/process-changelog@master
with:
  # Tag of the release, must be greater than last release and use semVer [major.minor.patch.build]
  # Required: true
  tag: ''
  # Body of the release notes
  # Required: true
  body: ''
  # Path to the config file to add the generated changelog node to
  # Required: true
  path: ''

update-assembly-info

Uses bash to replace placeholder @version@ in assemblyInfo file

uses: KSP-RO/BuildTools/update-assembly-info@master
with:
  # Path to assemblyInfo
  # Required: true
  path: ''
  # Tag of the release uses semVer [major.minor.patch.build]
  # Required: true
  tag: ''

update-version-in-readme

Replaces compare/version...master with compare/new_version...master in readme

uses: KSP-RO/BuildTools/update-version-in-readme@master
with:
  # Path to readme
  # Required: true
  path: ''
  # Tag of the release uses semVer [major.minor.patch.build]
  # Required: true
  tag: ''

update-version-file

Replaces the version in the .version file, both in the version node and links

uses: KSP-RO/BuildTools/update-version-file@master
with:
  # Path to readme
  # Required: true
  path: ''
  # Tag of the release uses semVer [major.minor.patch.build]
  # Required: true
  tag: ''