Skip to content

Change: Update README.md for CHANGELOG_<product>.md #5

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.

Sign up for GitHub

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

Merged
greenbonebot merged 2 commits into from
May 12, 2026
Merged

Change: Update README.md for CHANGELOG_<product>.md #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc73bb8
Change: Update README.md for CHANGELOG_<product>.md
pascalholthaus May 12, 2026
ef8a069
Update README.md
pascalholthaus May 12, 2026
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
127 changes: 15 additions & 112 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

Compose Artifacts, Release Logs and Sboms for Greenbone OPENVAS Containerized Products

> [!IMPORTANT]
> Only production releases are published here!

## Folder Structure

### Layout
Expand All @@ -10,138 +13,37 @@ Compose Artifacts, Release Logs and Sboms for Greenbone OPENVAS Containerized Pr
/
├── <product>/
│ ├── dev/
│ │ └── CHANGELOG_<product>.md
│ │ └── <version>/
│ │ ├── <product>.tar.gz
│ │ └── release-log-<product>.md
│ │ └── RELEASE-<product>.md
│ │ └── sboms
│ ├── integration/
│ │ └── CHANGELOG_<product>.md
│ │ └── <version>/
│ │ ├── <product>.tar.gz
│ │ └── release-log-<product>.md
│ │ └── RELEASE-<product>.md
│ │ └── sboms
│ ├── testing/
│ │ └── CHANGELOG_<product>.md
│ │ └── <version>/
│ │ ├── <product>.tar.gz
│ │ └── release-log-<product>.md
│ │ └── RELEASE-<product>.md
│ │ └── sboms
│ ├── staging/
│ │ └── CHANGELOG_<product>.md
│ │ └── <version>/
│ │ ├── <product>.tar.gz
│ │ └── release-log-<product>.md
│ │ └── RELEASE-<product>.md
│ │ └── sboms
│ └── production/
│ │ └── CHANGELOG_<product>.md
│ └── <version>/
│ ├── <product>.tar.gz
│ └── release-log-<product>.md
│ │ └── RELEASE-<product>.md
│ │ └── sboms
```

### Detailed Layout
```
/openvas-enterprise-container/
├── dev/
│ ├── v1.0.0-alpha.1/
│ │ ├── openvas-enterprise-container.tar.gz # Compose artifacts for dev v1.0.0-alpha.1
│ │ └── release-log-openvas-enterprise-container.md # Release notes for dev v1.0.0-alpha.1
│ │ └── sboms
│ ├── v1.0.0-alpha.2/
│ │ ├── openvas-enterprise-container.tar.gz
│ │ └── release-log-openvas-enterprise-container.md
│ │ └── sboms
│ └── ...
├── integration/
│ ├── v1.0.0-alpha.3/
│ │ ├── openvas-enterprise-container.tar.gz
│ │ └── release-log-openvas-enterprise-container.md
│ │ └── sboms
│ └── ...
├── testing/
│ ├── v1.0.0-rc.1/
│ │ ├── openvas-enterprise-container.tar.gz
│ │ └── release-log-openvas-enterprise-container.md
│ │ └── sboms
│ └── ...
├── staging/
│ ├── v1.0.0/
│ │ ├── openvas-enterprise-container.tar.gz
│ │ └── release-log-openvas-enterprise-container.md
│ │ └── sboms
│ └── ...
├── production/
│ ├── v1.0.0/
│ │ ├── openvas-enterprise-container.tar.gz
│ │ └── release-log-openvas-enterprise-container.md
│ │ └── sboms
│ └── ...
└── ...

/detect/
├── dev/
│ ├── v1.0.0-alpha.1/
│ │ ├── detect.tar.gz
│ │ └── release-log-detect.md
│ │ └── sboms
│ └── ...
├── integration/
│ ├── v1.0.0-alpha.3/
│ │ ├── detect.tar.gz
│ │ └── release-log-detect.md
│ │ └── sboms
│ └── ...
├── testing/
│ ├── v1.0.0-rc.1/
│ │ ├── detect.tar.gz
│ │ └── release-log-detect.md
│ │ └── sboms
│ └── ...
├── staging/
│ ├── v1.0.0/
│ │ ├── detect.tar.gz
│ │ └── release-log-detect.md
│ │ └── sboms
│ └── ...
├── production/
│ ├── v1.0.0/
│ │ ├── detect.tar.gz
│ │ └── release-log-detect.md
│ │ └── sboms
│ └── ...
└── ...

/security-intelligence/
├── dev/
│ ├── v1.0.0-alpha.1/
│ │ ├── security-intelligence.tar.gz
│ │ └── release-log-security-intelligence.md
│ │ └── sboms
│ └── ...
├── integration/
│ ├── v1.0.0-alpha.3/
│ │ ├── security-intelligence.tar.gz
│ │ └── release-log-security-intelligence.md
│ │ └── sboms
│ └── ...
├── testing/
│ ├── v1.0.0-rc.1/
│ │ ├── security-intelligence.tar.gz
│ │ └── release-log-security-intelligence.md
│ │ └── sboms
│ └── ...
├── staging/
│ ├── v1.0.0/
│ │ ├── security-intelligence.tar.gz
│ │ └── release-log-security-intelligence.md
│ │ └── sboms
│ └── ...
├── production/
│ ├── v1.0.0/
│ │ ├── security-intelligence.tar.gz
│ │ └── release-log-security-intelligence.md
│ │ └── sboms
│ └── ...
└── ...
```

### Explanation
- **Products**: `openvas-enterprise-container`, `detect`, `security-intelligence`
- **Stages**: `dev`, `integration`, `testing`, `staging`, `production`
Expand All @@ -153,5 +55,6 @@ Compose Artifacts, Release Logs and Sboms for Greenbone OPENVAS Containerized Pr
- **Version Folders**: Each stage contains version-specific folders.
- **Files**:
- **`<PRODUCT>.tar.gz`**: Compose artifacts for the version.
- **`release-log-<PRODUCT>.md`**: Release notes and logs for the product.
- **`RELEASE-<product>.md`**: Release info for the product.
- **`CHANGELOG_<product>.md`**: Change log for the product.
- **`sboms`**: Service Sboms.
Loading