Skip to content

Commit

Permalink
Add README and action branding
Browse files Browse the repository at this point in the history
  • Loading branch information
Fishbowler committed Oct 14, 2024
1 parent e86388e commit 2f4f4bf
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 0 deletions.
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Openfire Launcher action

An action for launching [Openfire](https://github.com/igniterealtime/Openfire), an XMPP server implementation, in the context of a Github Action workflow. It's not intended for anything production-facing, or even really user-facing. It's useful for CI-based short-lived actions that need an XMPP server.

## Inputs

### version

Version of Openfire to launch, in the form `a.b.c`, as seen in [Openfire Releases](https://github.com/igniterealtime/Openfire/releases).

example:

```yaml
- name: Run Openfire
uses: igniterealtime/openfire-launcher
with:
version: 4.9.0
```
### daily
Ignores any provided version, and loads the latest daily build of Openfire instead.
example:
```yaml
- name: Run Openfire
uses: igniterealtime/openfire-launcher
with:
daily: 'true'
```
### config
By default, the action launches with the demoboot config (the config file is [here](https://github.com/igniterealtime/Openfire/blob/main/distribution/src/conf/openfire-demoboot.xml), some docs [here](https://download.igniterealtime.org/openfire/docs/latest/documentation/client-minimal-working-example-smack.html#preparations)).
You can pass a different config file in to get alternative or additional config (e.g. adding additional configuration for plugins).
example:
```yaml
- name: Run Openfire
uses: igniterealtime/openfire-launcher
with:
config: ./my-config.xml
```
2 changes: 2 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
name: 'Launch Openfire'
description: 'Downloads and launches Openfire for use in a workflow'
branding:
color: 'orange'
inputs:
version:
description: 'The version of Openfire to download and launch'
Expand Down

0 comments on commit 2f4f4bf

Please sign in to comment.