Skip to content

Commit 5038201

Browse files
authored
Refinements to README
1 parent eddc17b commit 5038201

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,9 +173,11 @@ For details:
173173

174174
## [create-release](https://github.com/KSPModdingLibs/KSPBuildTools/blob/main/.github/workflows/create-release.yml)
175175

176-
Builds and packages a new version of mod. You can reference this workflow in your own repository on `workflow-dispatch` and have the user type in a version number. Then it does the rest!
176+
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!
177177

178-
After running `update-version`, this workflow commits the 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.
178+
**Note that 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.**
179+
180+
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.
179181

180182
For details:
181183

@@ -277,7 +279,7 @@ Inputs:
277279

278280
## [update-version](https://github.com/KSPModdingLibs/KSPBuildTools/blob/main/.github/actions/update-version/action.yml)
279281

280-
Uses `yaclog` and `yaclog-ksp` to update a changelog and get release notes. Then runs [update-version.sh](#update-version.sh) to replace version tokens in several text files. All modifications will be staged to git but not committed.
282+
Uses [yaclog](https://yaclog.readthedocs.io/en/latest/index.html) and [yaclog-ksp](https://pypi.org/project/yaclog-ksp/) to update a changelog and get release notes. Then runs [update-version.sh](#update-version.sh) to replace version tokens in several text files. All modifications will be staged to git but not committed.
281283

282284
Inputs:
283285

0 commit comments

Comments
 (0)