diff --git a/.github/actions/mask-input/action.yml b/.github/actions/mask-input/action.yml deleted file mode 100644 index 23fe75e..0000000 --- a/.github/actions/mask-input/action.yml +++ /dev/null @@ -1,19 +0,0 @@ -name: mask-input - -inputs: - input-name: - type: string - required: true - output-variable-name: - type: string - required: true - - runs: - using: composite - steps: - shell: bash - run: | - # see https://dev.to/leading-edje/masking-input-parameters-in-github-actions-1ci - ${{ inputs.output-variable-name }}=$(jq -r '.inputs."${{ inputs.input-name }}"' $GITHUB_EVENT_PATH) - echo ::add-mask::$${{ inputs.output-variable-name }} - echo ${{ inputs.output-variable-name }}=$${{ inputs.output-variable-name }} >> $GITHUB_ENV diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 486ae2c..9a1d6be 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -39,6 +39,7 @@ jobs: build: runs-on: ubuntu-22.04 steps: + - run: echo "::warning:: Due to the inability to properly pin them, reusable workflows in KSPBuildTools will be deprecated in the next major version" - name: Checkout Mod Repo uses: actions/checkout@v4 with: diff --git a/.github/workflows/create-release.yml b/.github/workflows/create-release.yml index cb50cb9..d5e9a0e 100644 --- a/.github/workflows/create-release.yml +++ b/.github/workflows/create-release.yml @@ -58,6 +58,8 @@ jobs: build: runs-on: ubuntu-22.04 steps: + - run: echo "::warning:: Due to the inability to properly pin them, reusable workflows in KSPBuildTools will be deprecated in the next major version" + - name: Checkout Mod Repo uses: actions/checkout@v4 with: diff --git a/.github/workflows/publish-to-spacedock.yml b/.github/workflows/publish-to-spacedock.yml index c9c2955..92e1f7b 100644 --- a/.github/workflows/publish-to-spacedock.yml +++ b/.github/workflows/publish-to-spacedock.yml @@ -29,6 +29,8 @@ jobs: publish-to-spacedock: runs-on: ubuntu-24.04 steps: + - run: echo "::warning:: Due to the inability to properly pin them, reusable workflows in KSPBuildTools will be deprecated in the next major version" + - name: get-release-info id: get-release-info uses: KSPModdingLibs/KSPBuildTools/.github/actions/get-release-info@main diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml index a5a148b..1db5f2b 100644 --- a/.github/workflows/validate.yml +++ b/.github/workflows/validate.yml @@ -8,6 +8,8 @@ jobs: validate: runs-on: ubuntu-24.04 steps: + - run: echo "::warning:: Due to the inability to properly pin them, reusable workflows in KSPBuildTools will be deprecated in the next major version" + - name: Checkout repo uses: actions/checkout@v4 diff --git a/docs/index.md b/docs/index.md index 02968bc..579e8be 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,7 +8,6 @@ maxdepth: 2 --- msbuild/index actions/index -workflows/index scripts ``` \ No newline at end of file diff --git a/docs/workflows/build.md b/docs/workflows/build.md deleted file mode 100644 index 1703799..0000000 --- a/docs/workflows/build.md +++ /dev/null @@ -1,15 +0,0 @@ -# Build - -```{gha:workflow} ---- -path: .github/workflows/build.yml ---- - -Compiles a KSP mod and uploads the results as a workflow artifact. It's meant to be suitable for continuous integration builds, as it simply compiles whatever is in the repository without updating version numbers etc. - -For details: - -* [compile action](#compile) -* [assemble-release action](#assemble-release) - -``` \ No newline at end of file diff --git a/docs/workflows/create-release.md b/docs/workflows/create-release.md deleted file mode 100644 index e7116d8..0000000 --- a/docs/workflows/create-release.md +++ /dev/null @@ -1,23 +0,0 @@ -# Create Release - -````{gha:workflow} ---- -path: .github/workflows/create-release.yml ---- - -Builds and packages a new version of mod. You can reference this workflow in your own repository on [workflow-dispatch](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow) 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 {gha:action}`update-version`, this workflow commits the changelog and version file changes and creates a new tag. Then it runs {gha:action}`compile` and {gha:action}`assemble-release`. And then finally it creates a draft github release with the packaged mod attached. -For details: - -* [update-version action](#update-version) -* [compile action](#compile) -* [assemble-release action](#assemble-release) - -[Example usage from RasterPropMonitor](https://github.com/JonnyOThan/RasterPropMonitor/blob/master/.github/workflows/create-release.yml) - -```` \ No newline at end of file diff --git a/docs/workflows/index.md b/docs/workflows/index.md deleted file mode 100644 index bf9ed7e..0000000 --- a/docs/workflows/index.md +++ /dev/null @@ -1,16 +0,0 @@ -# Github Workflows - -KSPBuildTools provides several reusable workflows for use with Github Actions. These are full-blown workflows that can be triggered from your own repository on certain events. - -For usage, see [Reusing Workflows](https://docs.github.com/en/actions/sharing-automations/reusing-workflows) in the Github docs. - -```{toctree} ---- -caption: Contents -maxdepth: 1 -glob: ---- - -* - -``` \ No newline at end of file diff --git a/docs/workflows/publish-to-spacedock.md b/docs/workflows/publish-to-spacedock.md deleted file mode 100644 index 0ee83a9..0000000 --- a/docs/workflows/publish-to-spacedock.md +++ /dev/null @@ -1,13 +0,0 @@ -# Publish To Spacedock - -````{gha:workflow} ---- -path: .github/workflows/publish-to-spacedock.yml ---- - -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. - -Calls 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. - -[Example from RasterPropMonitor](https://github.com/FirstPersonKSP/RasterPropMonitor/blob/master/.github/workflows/publish-to-spacedock.yml) -```` \ No newline at end of file diff --git a/docs/workflows/validate.md b/docs/workflows/validate.md deleted file mode 100644 index ede86dd..0000000 --- a/docs/workflows/validate.md +++ /dev/null @@ -1,10 +0,0 @@ -# Validate - -````{gha:workflow} ---- -path: .github/workflows/validate.yml ---- - -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. - -```` \ No newline at end of file