-
Notifications
You must be signed in to change notification settings - Fork 23
Release Updates 2.8.2 #732
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
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR updates the release to 2.8.2 by bumping versions in the OpenAPI spec, backend, and frontend configurations, and improves the OpenAPI validation script with a dedicated directory variable, an upgraded generator image, refined path checks, and a more robust Docker mount setup for SELinux. Flow diagram for updated OpenAPI validation scriptflowchart TD
A["Start validation-openapi.sh"] --> B["Set OPENAPI_DIR and OPENAPI_FILE variables"]
B --> C["Check if OpenAPI file exists at $OPENAPI_DIR/$OPENAPI_FILE"]
C -->|Exists| D["Run Docker container with openapi-generator-cli:v7.16.0"]
D --> E["Mount $OPENAPI_DIR to /local:Z (SELinux support)"]
E --> F["Validate OpenAPI spec at /local/openapi.yaml"]
F -->|Success| G["OpenAPI specification is valid!"]
F -->|Failure| H["OpenAPI specification validation failed!"]
C -->|Does not exist| I["Error: OpenAPI specification file not found"]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the project version from 2.8.1 to 2.8.2 across the codebase and improves the OpenAPI validation script configuration.
- Version bump from 2.8.1 to 2.8.2 in frontend, backend, and API specification
- OpenAPI validation script refactored to use separate directory and file variables with SELinux support
- OpenAPI generator version updated from v7.15.0 to v7.16.0
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| frontend/package.json | Updates frontend version to 2.8.2 |
| backend/pyproject.toml | Updates backend version to 2.8.2 |
| backend/ibutsu_server/openapi/openapi.yaml | Updates API specification version to 2.8.2 |
| scripts/validate-openapi.sh | Refactors path handling and updates generator version |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey there - I've reviewed your changes - here's some feedback:
- Verify that mounting only the openapi directory in validate-openapi.sh (with the :Z flag) doesn’t break any relative references or external schema includes in your OpenAPI spec.
- Double-check for any remaining version references elsewhere (e.g. CI configs or environment setup) to ensure everything is consistently bumped to 2.8.2.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Verify that mounting only the openapi directory in validate-openapi.sh (with the :Z flag) doesn’t break any relative references or external schema includes in your OpenAPI spec.
- Double-check for any remaining version references elsewhere (e.g. CI configs or environment setup) to ensure everything is consistently bumped to 2.8.2.
## Individual Comments
### Comment 1
<location> `scripts/validate-openapi.sh:35-41` </location>
<code_context>
fi
# Run the validation
+ # Mount the openapi directory directly to the container's working directory
+ # Use :Z for SELinux systems to allow container access
$container_cmd run --rm \
- -v "$(pwd):/local" \
</code_context>
<issue_to_address>
**suggestion:** Consider making SELinux volume flag conditional for non-SELinux systems.
On non-SELinux systems, ':Z' is not needed and could cause issues. Consider adding it only when SELinux is detected, or clarify SELinux is required.
```suggestion
# Detect if SELinux is enabled
if command -v getenforce >/dev/null 2>&1 && [ "$(getenforce)" = "Enforcing" ]; then
VOLUME_FLAG=":Z"
else
VOLUME_FLAG=""
fi
# Run the validation
# Mount the openapi directory directly to the container's working directory
# Add :Z for SELinux systems to allow container access
$container_cmd run --rm \
-v "$(pwd)/$OPENAPI_DIR:/local${VOLUME_FLAG}" \
"$GENERATOR_IMAGE" \
validate -i "/local/$OPENAPI_FILE"
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #732 +/- ##
======================================
Coverage ? 8.63%
======================================
Files ? 153
Lines ? 7218
Branches ? 596
======================================
Hits ? 623
Misses ? 6594
Partials ? 1
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Summary by Sourcery
Prepare release 2.8.2 by updating version numbers and enhancing the OpenAPI validation script.
Enhancements:
Chores: