diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 56 |
1 files changed, 56 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..a44db79 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +# Sourcehut Builds Noctalia Plugin + +A plugin for noctalia v5 that displays your last few sourcehut builds. + +It will display icons for recent running, failed or successful jobs +(with a configurable window.) + +## Plugin + +| Field | Value | +| --- | --- | +| ID | `rbdr/sourcehut-builds` | +| Plugin API | 30 | +| Entries | Bar widget: `bar`, panel: `panel`, service: `poller` | + +## Usage + +Configure your sourcehut API token in the plugin configuration, then add the +bar widget. + +You can toggle, open or close the panel by targeting `rbdr/sourcehut-builds:panel` + +```sh +noctalia msg panel-toggle rbdr/sourcehut-builds:panel +``` + +And you can open the settings by using the plugin id. + +```sh +noctalia msg settings-open-plugin rbdr/sourcehut-builds +``` + +| Action | Effect | +| --- | --- | +| Left click (bar glyph) | Open/close the panel | +| Left click on a build label | Open the build in the browser | +| Left click on a glyph for a task | Open the build in the browser, scroll the task into view | + +## Settings + +| Setting | What it does | +| --- | --- | +| Sourcehut API token| The token to use to connect to the sourcehut API | +| Build Count | The number of builds to show | +| Cutoff for recent builds | The number of seconds to consider "recent" for the glyph displays | + +## Install + +Checkout this repo somewhere in your computer, then add it as a plugin source +in noctalia settings, then enable the plugin. + +## No LLM Usage + +This project has not used LLMs in any stage of its development and does not +accept contributions where LLMs have been used in any point: whether it's +planning, debugging, testing, implementing or anything else. |