zhongwei/gh-openshift-eng-ai-helpers-plugins-component-health
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
Zhongwei Li
2025-11-30 08:45:43 +08:00
commit 77cb91c246
25 changed files with 7424 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

135
skills/get-release-dates/README.md Normal file
View File

@@ -0,0 +1,135 @@
# Get Release Dates
Fetch OpenShift release dates and metadata from the Sippy API.
## Overview
This skill retrieves release information for OpenShift releases, including:
- GA (General Availability) dates
- Development start dates
- Previous release in the sequence
- Release status (in development vs GA'd)
## Usage
```bash
python3 plugins/component-health/skills/get-release-dates/get_release_dates.py \
--release <release>
```
## Arguments
- `--release` (required): Release identifier (e.g., "4.21", "4.20", "4.17")
## Examples
### Get information for release 4.21
```bash
python3 plugins/component-health/skills/get-release-dates/get_release_dates.py \
--release 4.21
```
### Get information for release 4.17
```bash
python3 plugins/component-health/skills/get-release-dates/get_release_dates.py \
--release 4.17
```
## Output Format
### Successful Query (Release Found)
```json
{
"release": "4.21",
"found": true,
"ga": "2026-02-17T00:00:00Z",
"development_start": "2025-09-02T00:00:00Z",
"previous_release": "4.20"
}
```
### Release Not Found
```json
{
"release": "99.99",
"found": false
}
```
Exit code: 1
## Output Fields
- `release`: The release identifier queried
- `found`: Boolean indicating if release exists in Sippy
- `ga`: GA date. **Null means release is still in development.**
- `development_start`: When development started
- `previous_release`: Previous release in sequence
**Note**: If the `ga` field is `null`, the release is still under active development and has not reached General Availability yet.
## Prerequisites
- Python 3.6 or later
- Network access to `sippy.dptools.openshift.org`
## API Endpoint
The script queries: https://sippy.dptools.openshift.org/api/releases
## Use Cases
### Verify Release Exists
Before analyzing a release, verify it exists in Sippy:
```bash
python3 get_release_dates.py --release 4.21
# Check "found": true in output
```
### Get Release Timeline
Understand the development timeline:
```bash
python3 get_release_dates.py --release 4.17
# Check "development_start" and "ga" dates
```
### Determine Release Status
Check if a release is in development or has GA'd:
```bash
python3 get_release_dates.py --release 4.21
# If "ga" is null -> still in development
# If "ga" has timestamp -> has reached GA
```
## Error Handling
The script handles:
- Network errors (connection failures)
- HTTP errors (404, 500, etc.)
- Release not found (exit code 1)
- Invalid JSON responses
## Notes
- Uses Python standard library only (no external dependencies)
- Release identifiers are case-sensitive
- OKD releases use "-okd" suffix (e.g., "4.21-okd")
- Special releases: "Presubmits", "aro-production", "aro-stage", "aro-integration"
## See Also
- SKILL.md: Detailed implementation guide
- Component Health Plugin: `plugins/component-health/README.md`
- List Regressions Skill: `plugins/component-health/skills/list-regressions/`

258
skills/get-release-dates/SKILL.md Normal file
View File

@@ -0,0 +1,258 @@
---
name: Get Release Dates
description: Fetch OpenShift release dates and metadata from Sippy API
---
# Get Release Dates
This skill provides functionality to fetch OpenShift release information including GA dates and development start dates from the Sippy API.
## When to Use This Skill
Use this skill when you need to:
- Get GA (General Availability) date for a specific OpenShift release
- Find when development started for a release
- Identify the previous release in the sequence
- Validate if a release exists in Sippy
- Determine if a release is in development or has GA'd
## Prerequisites
1. **Python 3 Installation**
- Check if installed: `which python3`
- Python 3.6 or later is required
- Comes pre-installed on most systems
2. **Network Access**
- The script requires network access to reach the Sippy API
- Ensure you can make HTTPS requests to `sippy.dptools.openshift.org`
## Implementation Steps
### Step 1: Verify Prerequisites
First, ensure Python 3 is available:
```bash
python3 --version
```
If Python 3 is not installed, guide the user through installation for their platform.
### Step 2: Locate the Script
The script is located at:
```
plugins/component-health/skills/get-release-dates/get_release_dates.py
```
### Step 3: Run the Script
Execute the script with the release parameter:
```bash
# Get dates for release 4.21
python3 plugins/component-health/skills/get-release-dates/get_release_dates.py \
--release 4.21
# Get dates for release 4.20
python3 plugins/component-health/skills/get-release-dates/get_release_dates.py \
--release 4.20
```
### Step 4: Process the Output
The script outputs JSON data with the following structure:
```json
{
"release": "4.21",
"found": true,
"ga": "2026-02-17T00:00:00Z",
"development_start": "2025-09-02T00:00:00Z",
"previous_release": "4.20"
}
```
**Field Descriptions**:
- `release`: The release identifier that was queried
- `found`: Boolean indicating if the release exists in Sippy
- `ga`: GA (General Availability) date. **If null, the release is still in development.**
- `development_start`: When development started for this release
- `previous_release`: The previous release in the sequence (empty string if none)
**If Release Not Found**:
```json
{
"release": "99.99",
"found": false
}
```
**Release Status - Development vs GA'd**:
- **In Development**: If `ga` is `null`, the release is still under active development
```json
{
"release": "4.21",
"found": true,
"development_start": "2025-09-02T00:00:00Z",
"previous_release": "4.20"
}
```
- **GA'd (Released)**: If `ga` has a timestamp, the release has reached General Availability
```json
{
"release": "4.17",
"found": true,
"ga": "2024-10-01T00:00:00Z",
"development_start": "2024-05-17T00:00:00Z",
"previous_release": "4.16"
}
```
### Step 5: Use the Information
Based on the release dates:
1. **Determine release status**: Check if release is in development or GA'd
- If `ga` is `null`: Release is still in development
- If `ga` has a timestamp: Release has reached General Availability
2. **Determine release timeline**: Use `development_start` and `ga` dates
- Calculate time in development: `ga` - `development_start`
- For in-development releases: Calculate time since `development_start`
3. **Find related releases**: Use `previous_release` to navigate the release sequence
4. **Validate release**: Check `found` field before using the release in other operations
## Error Handling
The script handles several error scenarios:
1. **Network Errors**: If unable to reach Sippy API
```
Error: URL Error: [reason]
```
2. **HTTP Errors**: If API returns an error status
```
Error: HTTP Error 404: Not Found
```
3. **Invalid Release**: Script returns exit code 1 with `found: false` in output
4. **Parsing Errors**: If API response is malformed
```
Error: Failed to fetch release dates: [details]
```
## Output Format
The script outputs JSON to stdout with:
- **Success**: Exit code 0, JSON with `found: true`
- **Release Not Found**: Exit code 1, JSON with `found: false`
- **Error**: Exit code 1, error message to stderr
## API Details
The script queries the Sippy releases API:
- **URL**: https://sippy.dptools.openshift.org/api/releases
- **Method**: GET
- **Response**: JSON containing all releases and their metadata
The full API response includes:
- `releases`: Array of all available release identifiers
- `ga_dates`: Simple mapping of release to GA date
- `dates`: Detailed mapping with GA and development_start dates
- `release_attrs`: Extended attributes including previous release
## Examples
### Example 1: Get Current Development Release
```bash
python3 plugins/component-health/skills/get-release-dates/get_release_dates.py \
--release 4.21
```
Output:
```json
{
"release": "4.21",
"found": true,
"development_start": "2025-09-02T00:00:00Z",
"previous_release": "4.20"
}
```
### Example 2: Get GA'd Release
```bash
python3 plugins/component-health/skills/get-release-dates/get_release_dates.py \
--release 4.17
```
Output:
```json
{
"release": "4.17",
"found": true,
"ga": "2024-10-01T00:00:00Z",
"development_start": "2024-05-17T00:00:00Z",
"previous_release": "4.16"
}
```
### Example 3: Query Non-Existent Release
```bash
python3 plugins/component-health/skills/get-release-dates/get_release_dates.py \
--release 99.99
```
Output:
```json
{
"release": "99.99",
"found": false
}
```
Exit code: 1
## Integration with Other Commands
This skill can be used in conjunction with other component-health skills:
1. **Before analyzing regressions**: Verify the release exists
2. **Timeline context**: Understand how long a release has been in development
3. **Release status**: Determine if a release is in development or has GA'd
4. **Release navigation**: Find previous/next releases in the sequence
## Notes
- The script uses Python's standard library only (no external dependencies)
- API responses are cached by Sippy, so repeated calls are fast
- Release identifiers are case-sensitive (use "4.21" not "4.21.0")
- OKD releases are suffixed with "-okd" (e.g., "4.21-okd")
- ARO releases have special identifiers (e.g., "aro-production")
- "Presubmits" is a special release for pull request data
## See Also
- Skill Documentation: `plugins/component-health/skills/list-regressions/SKILL.md`
- Sippy API: https://sippy.dptools.openshift.org/api/releases
- Component Health Plugin: `plugins/component-health/README.md`

137
skills/get-release-dates/get_release_dates.py Normal file
View File

@@ -0,0 +1,137 @@
#!/usr/bin/env python3
"""
Fetch OpenShift release dates from Sippy API.
This script fetches release information including GA dates and development start dates
for OpenShift releases from the Sippy API.
"""
import argparse
import json
import sys
import urllib.request
import urllib.error
def fetch_release_dates():
"""
Fetch all release dates from Sippy API.
Returns:
Dictionary containing release information
Raises:
Exception: If the API request fails
"""
url = "https://sippy.dptools.openshift.org/api/releases"
try:
with urllib.request.urlopen(url) as response:
data = json.loads(response.read().decode('utf-8'))
return data
except urllib.error.HTTPError as e:
raise Exception(f"HTTP Error {e.code}: {e.reason}")
except urllib.error.URLError as e:
raise Exception(f"URL Error: {e.reason}")
except Exception as e:
raise Exception(f"Failed to fetch release dates: {str(e)}")
def get_release_info(data: dict, release: str) -> dict:
"""
Extract information for a specific release.
Args:
data: Full API response containing all release data
release: Release identifier (e.g., "4.21", "4.20")
Returns:
Dictionary containing release-specific information
Note:
If 'ga' and 'ga_date' fields are null/missing, the release is still
in development and has not reached General Availability yet.
"""
result = {
"release": release,
"found": False
}
# Check if release exists in the releases list
if release in data.get("releases", []):
result["found"] = True
# Get detailed dates (GA and development start)
dates = data.get("dates", {})
if release in dates:
release_dates = dates[release]
result["ga"] = release_dates.get("ga")
result["development_start"] = release_dates.get("development_start")
# Get release attributes if available
release_attrs = data.get("release_attrs", {})
if release in release_attrs:
attrs = release_attrs[release]
result["previous_release"] = attrs.get("previous_release", "")
return result
def format_output(data: dict) -> str:
"""
Format the release data for output.
Args:
data: Dictionary containing release information
Returns:
Formatted JSON string
"""
return json.dumps(data, indent=2)
def main():
parser = argparse.ArgumentParser(
description='Fetch OpenShift release dates from Sippy',
formatter_class=argparse.RawDescriptionHelpFormatter,
epilog="""
Examples:
# Get dates for release 4.21
python3 get_release_dates.py --release 4.21
# Get dates for release 4.20
python3 get_release_dates.py --release 4.20
"""
)
parser.add_argument(
'--release',
type=str,
required=True,
help='Release version (e.g., "4.21", "4.20")'
)
args = parser.parse_args()
try:
# Fetch all release data
data = fetch_release_dates()
# Extract info for the specific release
release_info = get_release_info(data, args.release)
# Format and print output
output = format_output(release_info)
print(output)
# Return exit code based on whether release was found
return 0 if release_info["found"] else 1
except Exception as e:
print(f"Error: {e}", file=sys.stderr)
return 1
if __name__ == '__main__':
sys.exit(main())