56 lines
2.0 KiB
Plaintext
56 lines
2.0 KiB
Plaintext
---
|
|
title: "Releases"
|
|
description: "Displays a list of the current version of the given repositories with the given version regex."
|
|
hide_title: true
|
|
---
|
|
|
|
import { WidgetInteractionGuide } from "@site/src/components/widgets/interactions";
|
|
|
|
import { AddingWidget } from "@site/src/components/widgets/adding";
|
|
import { WidgetConfig } from "@site/src/components/widgets/configuration";
|
|
import { WidgetHeader } from "@site/src/components/widgets/header";
|
|
import { releasesWidget } from ".";
|
|
|
|
<WidgetHeader widget={releasesWidget} categories={["Releases", "Software"]} />
|
|
|
|
The releases widget enables you to track a list of repositories and see their respective latest release.
|
|
It also supports importing releases from your local docker containers.
|
|
|
|
### Screenshots
|
|
|
|
import collapsibleCard from "./img/collapsible.png";
|
|
import fullCard from "./img/full.png";
|
|
import noDetailsCard from "./img/no-details.png";
|
|
|
|
<div className="flex gap-1">
|
|
<img src={fullCard} alt="releases full" width={128 * 3} />
|
|
<img src={collapsibleCard} alt="releases collapsible" width={128 * 3} />
|
|
<img src={noDetailsCard} alt="releases no details" width={128 * 3} />
|
|
</div>
|
|
|
|
### Supported Providers
|
|
|
|
GitHub, Docker Hub, GitLab, NPM, Codeberg, GitHub Container Registry, Quay, and LinuxServer.io are configured per repository in the widget.
|
|
|
|
For GitHub Container Registry, use `owner/package` identifiers such as `homarr-labs/homarr`.
|
|
Full image references such as `ghcr.io/homarr-labs/homarr:latest` are also accepted.
|
|
|
|
<WidgetInteractionGuide advancedView={false} />
|
|
|
|
### Adding the widget
|
|
|
|
<AddingWidget />
|
|
|
|
### Configuration
|
|
|
|
<WidgetConfig configuration={releasesWidget.configuration} />
|
|
|
|
:::note
|
|
|
|
The version filter is used to match the version tag of the release. It is a combination of the prefix, precision and suffix.
|
|
|
|
Setting the Prefix to `v`, precision to `2` and the Suffix to `-alpha`, will match `v1.0-alpha` but not `v1.0-beta`.
|
|
Setting the Prefix to `v`, precision to `3`, will match `v5.2.0` but not `v1.0.2-alpha` or `Beta v5.2.1`.
|
|
|
|
:::
|