Skip to content

Commit

Permalink
Add more explanation to the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Kevinjil committed Jun 7, 2022
1 parent 0e6c424 commit 1c95ff8
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
# jellyfin-plugin-repo-action

A GitHub action which generates a Jellyfin plugin repository manifest file as a GitHub action.
This plugin can be used in a GitHub workflow which builds release builds or nightly prerelease builds and publishes the generated plugin repository manifest file to a selected branch.
Toghether with GitHub pages, this can form a convenient way to host the plugin repository completely on GitHub.

## Usage

See [action.yml](action.yml)
To use this plugin, integrate it in your workflow. A complete example for a release build workflow is given in the [Jellyfin.Xtream publish workflow](https://github.com/Kevinjil/Jellyfin.Xtream/blob/master/.github/workflows/publish.yaml)
For detailed information about the configuration parameters, take a look at the [action.yml](action.yml) file.

## How it works

This pipeline queries the GitHub API for all releases of the given repository. This information, together with information in the git repository itself, is used as the only stateful information that this plugin uses.

For every release, the release notes are used as a changelog and the version information is extracted.
It also inspects the build artifacts to determine the download url of the plugin release by picking the asset with file extension `.zip` and the checksum by downloading the file with extension `.md5`.
Furthermore, it extracts the build information from the `build.yaml` file if it exists as release asset, and falls back to the `build.yaml` file at the release tag in the git repository.

Global plugin information such as the `guid` is extracted from the `build.yaml` file at the main branch of the repository.

0 comments on commit 1c95ff8

Please sign in to comment.