feat: release 1.0.0 with comprehensive API improvements and bug fixes #96
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BREAKING CHANGE: The property name `readinessIimeoutSeconds` in PloneBaseOptions has been renamed to `readinessTimeoutSeconds` to fix the typo.
BREAKING CHANGE: The property name `livenessIimeoutSeconds` in PloneBaseOptions has been renamed to `livenessTimeoutSeconds` to fix the typo.
Previously, all services used the hardcoded port name 'backend-http', including frontend services. Now the port name is configurable via PloneServiceOptions.portName with a default of 'http'. Backend services now explicitly use 'backend-http' and frontend services use 'frontend-http' for better clarity in Kubernetes.
Added detailed JSDoc documentation to all interfaces and classes: - PloneBaseOptions: detailed docs for all configuration properties - PloneOptions: main Plone configuration interface - PloneVariant: enum with descriptions - Plone class: comprehensive class and property documentation - PloneHttpcacheOptions: Varnish cache configuration - PloneHttpcache class: detailed usage documentation - PloneImageOptions, PloneDeploymentOptions: deployment configuration - PloneDeployment, PloneService, PlonePDB: internal construct docs - PlonePDBOptions, PloneServiceOptions: supporting interfaces All public APIs now have: - Clear descriptions of purpose and usage - @default tags for default values - @example tags where helpful - Parameter type explanations
Added 'replicas' option to PloneHttpcacheOptions to allow configuring the number of Varnish pods. Previously hardcoded to 2. Default remains 2 for backward compatibility.
Added comprehensive annotation support following Kubernetes best practices: - PloneDeploymentOptions: added 'annotations' (for Deployment metadata) and 'podAnnotations' (for Pod template metadata) - PloneServiceOptions: added 'annotations' for Service metadata - PloneBaseOptions: added 'annotations', 'podAnnotations', and 'serviceAnnotations' for configuring backend and frontend Common use cases: - Prometheus scraping configuration on pods - External-DNS hostname configuration on services - Istio/service mesh sidecar injection - Backup and monitoring policies - Custom metadata for operators and controllers All annotations are optional and default to undefined (no annotations).
jensens
changed the title
- Restructure with clearer sections and better formatting - Add comprehensive Quick Start examples - Update API documentation section with corrected property names - Fix typos (readinessTimeoutSeconds, livenessTimeoutSeconds) - Add new annotation options documentation - Improve installation instructions for both npm and pip - Add complete development workflow documentation - Remove outdated ToDo section - Add references section with helpful links 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR includes comprehensive improvements to the CDK8S Plone library in preparation for the 1.0.0 release:
readinessTimeoutSeconds,livenessTimeoutSeconds)Key Changes
Documentation Enhancements
Plone,PloneHttpcache, and all option interfacesBug Fixes
readinessIimeoutSeconds→readinessTimeoutSeconds(in PloneBaseOptions)livenessIimeoutSeconds→livenessTimeoutSeconds(in PloneBaseOptions)backend,frontend,http) instead of generic namesNew Features
annotationsproperty to PloneBaseOptions for Deployment metadata annotationspodAnnotationsproperty to PloneBaseOptions for Pod template annotationsserviceAnnotationsproperty to PloneBaseOptions for Service metadata annotationsreplicasproperty to PloneHttpcacheOptions for configurable Varnish replica countTesting
Migration Notes
If you were using the misspelled properties
readinessIimeoutSecondsorlivenessIimeoutSeconds, update them to the correct spelling:readinessTimeoutSecondsandlivenessTimeoutSeconds.Commits Included
🤖 Generated with Claude Code