78 lines
2.6 KiB
Plaintext
78 lines
2.6 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 { AddingWidget } from '@site/src/components/widgets/adding';
|
|
import { WidgetConfig } from '@site/src/components/widgets/configuration';
|
|
import { WidgetHeader } from '@site/src/components/widgets/header';
|
|
import { WidgetIntegrations } from '@site/src/components/widgets/integrations';
|
|
import { releasesWidget } from '.';
|
|
import { githubIntegration } from '@site/docs/integrations/github';
|
|
import { gitlabIntegration } from '@site/docs/integrations/gitlab';
|
|
import { dockerHubIntegration } from '@site/docs/integrations/docker-hub';
|
|
import { npmIntegration } from '@site/docs/integrations/npm';
|
|
import { codebergIntegration } from '@site/docs/integrations/codeberg';
|
|
|
|
<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';
|
|
import { quayIntegration } from '@site/docs/integrations/quay';
|
|
import { gitHubContainerRegistryIntegration } from '@site/docs/integrations/github-containerregistry';
|
|
import { linuxServerIoIntegration } from '@site/docs/integrations/linux-server-io';
|
|
|
|
<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 Integrations
|
|
|
|
<WidgetIntegrations items={[{
|
|
integration: githubIntegration,
|
|
}, {
|
|
integration: gitlabIntegration,
|
|
}, {
|
|
integration: dockerHubIntegration,
|
|
}, {
|
|
integration: npmIntegration,
|
|
}, {
|
|
integration: codebergIntegration,
|
|
}, {
|
|
integration: gitHubContainerRegistryIntegration,
|
|
note: "Use if release is only available in ghcr.io"
|
|
}, {
|
|
integration: quayIntegration
|
|
}, {
|
|
integration: linuxServerIoIntegration
|
|
}]} />
|
|
|
|
### 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`.
|
|
|
|
:::
|
|
|