Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a disclaimer for the feed version and used gvmd version #257

Merged
merged 1 commit into from
Feb 10, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,17 @@ configurable and can be adjusted easily for downloading different feed versions.

Versions prior to 25.0.0 used [calendar versioning](https://calver.org/).

> [!IMPORTANT]
> `greenbone-feed-sync` >= 25.0.0 requires [gvmd 25.0.0](https://github.com/greenbone/gvmd/releases/tag/v25.0.0)
> to work out of the box. If a version of gvmd < 24.0.0 is used, the feed version
> has to be set to 22.04 via the [config file, the `GREENBONE_FEED_SYNC_FEED_VERSION`
> environment variable or the `--feed-version` CLI argument](#feed-version).
> For example run `greenbone-feed-sync --feed-version 22.04`.
> Alternatively you can downgrade `greenbone-feed-sync` to a release < 25.0.0.
>
> Versions of gvmd between 24.0.0 and 25.0.0 have issues with the feed loading
> and require manual interventions.

### Requirements

Python 3.9 and later is supported.
Expand Down
Loading