Skip to content

Commit

Permalink
docs: explain CI releases for contributors
Browse files Browse the repository at this point in the history
  • Loading branch information
strazto committed Aug 14, 2022
1 parent 5c0e4ec commit f0d16c3
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ The nightly build can be installed from the [main plugin repo](https://raw.githu

The nightly build may have new features unavailable in other builds, but **be warned**, things may change frequently in nightly builds, and things may break, and you could lose data.


## Roadmap

- [x] Admin page
Expand Down Expand Up @@ -220,7 +219,7 @@ There is also no logout callback. Logging out of Jellyfin will log you out of Je

This is built with .NET 6.0. Build with `dotnet publish .` for the debug release in the `SSO-Auth` directory. Copy over the `IdentityModel.OidcClient.dll`, the `IdentityModel.dll` and the `SSO-Auth.dll` files in the `/bin/Debug/net6.0/publish` directory to a new folder in your Jellyfin configuration: `config/plugins/sso`.

## VSCode Workflow
### VSCode Workflow

An example `.vscode` configuration may be found at [matthewstrasiotto/jellyfin-plugin-sso-vscode](https://github.com/matthewstrasiotto/jellyfin-plugin-sso-vscode).

Expand All @@ -238,6 +237,16 @@ This plugin uses [JPRM](https://github.com/oddstr13/jellyfin-plugin-repository-m

Build the zipped plugin with `jprm --verbosity=debug plugin build .`.

### CI Releases

Anything merged to the main branch will be built and published by our CI system.

Anything tagged/released as a formal Github release will also be built and published by our CI system.

If you wish to use releases from your own fork, refer to
[Installing](#installing), however, you will need to change the url to the
manifest file, https://raw.githubusercontent.com/9p4/jellyfin-plugin-sso/manifest-release/manifest.json
so that it refers to your fork.

## Credits and Thanks

Expand Down

0 comments on commit f0d16c3

Please sign in to comment.