Skip to content

Commit b8b6095

Browse files
authored
README: update with publish-to-spacedock docs
1 parent 234284c commit b8b6095

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,14 @@ For details:
240240

241241
[Example usage from RasterPropMonitor](https://github.com/JonnyOThan/RasterPropMonitor/blob/master/.github/workflows/create-release.yml)
242242

243+
## [publish-to-spacedock](https://github.com/KSPModdingLibs/blob/main/.github/workflows/publish-to-spacedock.yml)
244+
245+
Publishes a github release to Spacedock. You can reference this workflow from one in your own repository that is triggered on a release being published, so that it automatically also gets uploaded to Spacedock.
246+
247+
Calls [get-release-info](#get-release-info) and then uses KSP2Community's [spacedock-upload](https://github.com/KSP2Community/spacedock-upload) action to publish it. You will need to provide your spacedock username and mod id as variables, and the spacedock password as a secret. You could either hardcode the mod ID and username in your repository's workflow, or use a repository or organization variable.
248+
249+
[Example from RasterPropMonitor](https://github.com/FirstPersonKSP/RasterPropMonitor/blob/master/.github/workflows/publish-to-spacedock.yml)
250+
243251
## [validate](https://github.com/KSPModdingLibs/KSPBuildTools/blob/main/.github/workflows/validate.yml)
244252

245253
Performs validation to help check for errors. Right now it just invokes CKAN's KSPMMCfgParser action to check for syntax errors in cfg files, but it may do more in the future. You may want to add this to a continuous integration workflow that is triggered on pull requests and commits.
@@ -305,6 +313,30 @@ Inputs:
305313

306314
If the ksp library zip is encrypted, this is the password. It should be stored in your repository's secrets.
307315

316+
## [get-release-info](https://github.com/KSPModdingLibs/KSPBuildTools/blob/main/.github/actions/get-release-info/action.yml)
317+
318+
Fetches information about a published release on github. This is intended to be used to upload the release to other sites such as Spacedock.
319+
320+
Inputs:
321+
322+
* `release-tag`
323+
324+
The release tag to get info for. If left blank, gets the latest release.
325+
326+
Outputs:
327+
328+
* `version-string`
329+
330+
The tag of the release. Will be the same as `inputs.release-tag` unless it was blank.
331+
332+
* `changelog-file`
333+
334+
Filename of the changelog containing the release notes of the github release (typically in markdown format).
335+
336+
* `artifact-file`
337+
338+
Filename containing the asset from the release.
339+
308340
## [setup-ckan](https://github.com/KSPModdingLibs/KSPBuildTools/blob/main/.github/actions/setup-ckan/action.yml)
309341

310342
Installs [CKAN](https://github.com/KSP-CKAN/CKAN) and sets up a KSP installation

0 commit comments

Comments
 (0)