acn/github-action-koha-plugin-create-kpz

This is a clone of the GitHub action for creating a Koha Plugin kpz file which is compatible with Gitea Actions. https://github.com/bywatersolutions/github-action-koha-plugin-create-kpz

Go to file

Kyle M Hall e67b62bef1 Renamed META.yml to PLUGIN.yml		2020-04-22 08:53:21 -04:00
action.yml	Add missing parameter to parameter list	2020-04-16 09:59:33 -04:00
CHANGELOG.md	If the plugin contains submodules, one of those submodules may be selected by accident.	2020-04-16 15:00:31 -04:00
Dockerfile	Initial commit	2019-12-18 09:29:05 -05:00
entrypoint.sh	Renamed META.yml to PLUGIN.yml	2020-04-22 08:53:21 -04:00
README.md	Update echos	2020-04-16 09:38:32 -04:00

README.md

Koha Plugin kpz Builder

This action builds a kpz file from a given name and version. The file will be in your GitHub workspace after the action is run.

Inputs

`release-version`

Required Version for this koha plugin release, e.g. v1.0.3

`release-name`

Required Name of plugin, should almost always be the repo name, e.g. koha-plugin-kitchen-sink

`minimmum-version`

Required Minimum version of Koha this plugin is compatible with, e.g. 19.11 or 19.11.03

Best practice is to keep plugins compatible across all currently supported versions of Koha

Outputs

`filename`

The name of the built kpz file

Example usage

- name: Build Koha Plugin kpz artifact
  id: kpz
  uses: "bywatersolutions/github-action-koha-plugin-create-kpz@master"
  with:
    release-version: ${{ steps.semvers.outputs.v_patch }}
    release-name: ${{ steps.myvars.outputs.GITHUB_REPO }}
    minimum-version: ${{ steps.koha-version-oldstable.outputs.version-major-minor }}

Take a look at https://github.com/bywatersolutions/koha-plugin-kitchen-sink/blob/master/.github/workflows/main.yml for a real world usage.