chore: release v0.8.0 #218
Conversation
WalkthroughThis pull request focuses on version updates across the Augurs project workspace. The primary change involves incrementing the workspace and all related dependencies from version 0.7.0 to 0.8.0. Multiple changelog files have been updated to reflect this version bump, with specific notes about breaking changes, particularly around the Changes
Possibly related PRs
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
Cargo.toml(2 hunks)crates/augurs-core/CHANGELOG.md(1 hunks)crates/augurs-forecaster/CHANGELOG.md(1 hunks)crates/augurs-outlier/CHANGELOG.md(1 hunks)crates/augurs-prophet/CHANGELOG.md(1 hunks)crates/augurs/CHANGELOG.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- crates/augurs-outlier/CHANGELOG.md
🔇 Additional comments (7)
crates/augurs/CHANGELOG.md (1)
10-14: Verify breaking change documentation
The breaking change is properly documented with the correct version bump and [breaking] tag. However, given the PR objectives mention multiple breaking changes in augurs-core and augurs-forecaster, consider adding more details about other breaking changes.
Consider expanding the changelog entry to include:
- Specific modules/structs/traits that were removed or renamed
- Impact on downstream code
- Migration guide or upgrade instructions
✅ Verification successful
Let me gather information about the breaking changes by examining the codebase.
Let me search for more specific information about the breaking changes and the transform trait.
Based on the code analysis, I can now generate the final response:
Breaking changes properly documented, no additional changes needed
The switch of transform to a trait is the only breaking change in this release. The code shows this is a significant architectural change affecting the transformation system, where various transformers like MinMaxScaler, StandardScaler, BoxCox, YeoJohnson, etc. implement the Transformer trait. This change is correctly marked as breaking and the version bump from 0.7.0 to 0.8.0 follows semver.
The PR objectives mentioning multiple breaking changes in augurs-core and augurs-forecaster appear to be referring to this same transformation system change, as the transformation functionality is a core feature used across these crates. No additional breaking changes were found that would need separate documentation.
🏁 Scripts executed
The following scripts were executed for the analysis:
Error: No shell scripts found
Script:
#!/bin/bash
# Check PR description and commits for breaking change details
gh pr view --json title,body
# Look for transform trait implementation and related changes
ast-grep --pattern 'trait Transform'
# Search for other potential breaking changes in the codebase
rg -l "BREAKING" -g "!CHANGELOG.md"
# Check for any migration guides or upgrade instructions
fd README.md
Length of output: 733
Script:
#!/bin/bash
# Look for transform-related changes in Rust files
rg -A 5 "transform" -t rust
# Check commit messages in the relevant crates
fd Cargo.toml -t f -x cat {} | grep -A 1 "name.*augurs"
# Search for any upgrade or migration documentation
rg -i "upgrade|migration" -g "*.md"
# Look for any trait definitions and implementations
ast-grep --pattern 'impl Transform for $_'
Length of output: 74509
Cargo.toml (1)
21-21: Version updates are consistent
The workspace version and all augurs-* dependencies have been correctly updated to 0.8.0, maintaining consistency across the workspace.
Let's verify that all crates in the workspace have corresponding version updates:
Also applies to: 32-41
✅ Verification successful
Version updates are consistent across the workspace
The verification confirms that all version references in the workspace are correctly set to 0.8.0:
- Workspace version is set to 0.8.0 in
workspace.package - All augurs-* dependencies in
workspace.dependenciesare consistently versioned at 0.8.0 - All package manifests inherit the workspace version through
version.workspace = true
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify version consistency across workspace crates
# Check versions in all Cargo.toml files
echo "Checking versions in Cargo.toml files:"
fd Cargo.toml crates/ -x rg -l "version\s*=\s*\"0\.8\.0\""
# Check for any remaining 0.7.0 versions that might have been missed
echo -e "\nChecking for any remaining 0.7.0 versions:"
fd Cargo.toml crates/ -x rg -l "version\s*=\s*\"0\.7\.0\""
Length of output: 305
Script:
#!/bin/bash
# Let's try a different approach to check versions in Cargo.toml files
# First, let's find all Cargo.toml files and check their content
echo "=== Checking all version fields in Cargo.toml files ==="
fd Cargo.toml --type f -x cat {}
# Also check the workspace Cargo.toml
echo -e "\n=== Checking workspace Cargo.toml ==="
cat Cargo.toml
Length of output: 28017
crates/augurs-forecaster/CHANGELOG.md (1)
9-27: Comprehensive changelog with well-documented changes
The changelog properly documents the breaking changes, improvements, and fixes. The changes are well-categorized and align with the PR objectives.
Let's verify the referenced PRs are merged and the changes are included:
✅ Verification successful
Let me verify the transform trait changes to ensure the changelog accurately reflects the codebase changes.
Changelog entries accurately reflect the codebase changes
The verification confirms:
- All referenced PRs (Add power transformation logic to forecaster transforms #185-feat!: switch
transformto a trait #213) are merged - The breaking change of switching to a trait-based transform system is implemented (
Transformertrait in transforms.rs) - Transform modules are properly restructured into separate files under
transforms/ - Box-Cox and Yeo-Johnson implementations exist in the power transforms module
- Standard scaler and other transforms are present in the codebase
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify referenced PRs and changes
# Check if referenced PRs are merged
for pr in 213 212 204 195 203 194 210 196 185; do
echo "Checking PR #$pr:"
gh pr view $pr --json state,mergedAt
done
# Verify transform-related changes
echo -e "\nVerifying transform-related changes:"
rg -l "trait\s+Transform" crates/augurs-forecaster/src/
Length of output: 1854
Script:
#!/bin/bash
# Check transform trait implementation and module structure
echo "Transform trait definition:"
rg -A 10 "trait\s+Transform" crates/augurs-forecaster/src/
echo -e "\nTransform modules structure:"
fd . crates/augurs-forecaster/src/transforms/
echo -e "\nBox-Cox and Yeo-Johnson implementations:"
rg -l "Box.*Cox|Yeo.*Johnson" crates/augurs-forecaster/src/
Length of output: 1712
crates/augurs-core/CHANGELOG.md (2)
9-10: LGTM! Version entry follows the standard format
The version entry correctly follows the Keep a Changelog format with:
- Proper version number (0.8.0)
- Correct date format (2024-12-23)
- Valid GitHub comparison link
13-13: Enhance breaking change documentation
The breaking change entry "switch transform to a trait" should include:
- Migration guide for users
- List of removed/renamed public types
- Code examples showing how to update existing code
Let's check for any existing documentation about this breaking change:
crates/augurs-prophet/CHANGELOG.md (2)
10-11: LGTM! Version entry follows the standard format
The version entry correctly follows the Keep a Changelog format with:
- Proper version number (0.8.0)
- Correct date format (2024-12-23)
- Valid GitHub comparison link
23-23: Document potential breaking changes from wasmtime update
The update of wasmtime from version 27 to 28 might introduce breaking changes. Consider:
- Adding [breaking] tag if there are API changes
- Documenting any required code changes
- Including migration steps if needed
Let's check the wasmtime changelog for breaking changes:
✅ Verification successful
Let me check how wasmtime is used in the codebase to understand the impact of these changes.
Let me check the specific wasmtime features being used to understand if they're affected by the breaking changes.
No breaking changes impact detected - update is safe
After reviewing the wasmtime v28.0.0 changelog and the codebase usage, the update appears safe as:
- No breaking API changes affect the used features (Component, Linker, Engine, Store)
- Changes are mostly additions and internal improvements
- Memory-related changes don't impact the current usage
- The code uses stable public APIs that remain unchanged
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if wasmtime update introduces breaking changes
gh api repos/bytecodealliance/wasmtime/releases | jq -r '.[] | select(.tag_name == "v28.0.0") | .body'
Length of output: 3927
Script:
#!/bin/bash
# Search for wasmtime usage patterns
rg -A 3 "use wasmtime::"
Length of output: 496
Script:
#!/bin/bash
# Check the content of the file using wasmtime
cat crates/augurs-prophet/src/wasmstan.rs
Length of output: 9594
|
|
||
| ### Added | ||
|
|
||
| - add Forecaster wrapper for Prophet (#191) |
There was a problem hiding this comment.
💡 Codebase verification
Documentation needs improvement for the Forecaster wrapper
Based on the verification results, while there is a working example in examples/forecasting/examples/prophet_forecaster.rs and some API documentation in the source code, the Forecaster wrapper functionality needs better documentation:
- The main README focuses on the Prophet model but doesn't mention the Forecaster wrapper
- The implementation has inline documentation but lacks comprehensive usage guidelines
- Key features like transformation capabilities are only shown in examples
Suggested documentation additions:
- Add a dedicated section in README.md about the Forecaster wrapper
- Document integration with the
augursframework - Explain the transformation pipeline capabilities
- Provide clear examples of prediction interval generation
🔗 Analysis chain
Document the Forecaster wrapper functionality
The addition of the Forecaster wrapper for Prophet should include:
- Basic usage examples
- Key features and capabilities
- Integration guidelines
Let's check for existing documentation:
Let me check the example and documentation content in more detail:
Let me check if there's any additional documentation in the README or other documentation files:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for Forecaster wrapper documentation
rg -g '!target' -g '*.{md,rs}' -i 'forecaster.*wrapper|prophet.*forecaster'
Length of output: 2234
Script:
#!/bin/bash
# Check the example content
cat examples/forecasting/examples/prophet_forecaster.rs
# Check the implementation documentation
cat crates/augurs-prophet/src/forecaster.rs
Length of output: 8989
Script:
#!/bin/bash
# Check README and other potential documentation
cat crates/augurs-prophet/README.md 2>/dev/null || true
cat crates/augurs-prophet/src/lib.rs 2>/dev/null || true
Length of output: 9016
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
crates/augurs-forecaster/CHANGELOG.md(1 hunks)crates/augurs-prophet/CHANGELOG.md(1 hunks)crates/augurs/CHANGELOG.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- crates/augurs-prophet/CHANGELOG.md
- crates/augurs-forecaster/CHANGELOG.md
🔇 Additional comments (2)
crates/augurs/CHANGELOG.md (2)
10-11: LGTM! Version and date format are correct.
The version link and release date follow the Keep a Changelog format correctly.
12-13: Verify the migration guide link accessibility.
While the breaking changes notice is good, let's ensure the migration guide link is accessible.
✅ Verification successful
Let me verify the content of the migration guide to ensure it contains the specific section mentioned in the link (#from-07-to-08).
Migration guide link is valid and contains the referenced section
The migration guide exists at book/src/migrating.md and includes a detailed "From 0.7 to 0.8" section that properly documents the breaking changes mentioned in the changelog.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the migration guide link exists and is accessible
# Expected: Find the migration guide markdown file in the docs directory
fd -g "*migrating*" -t f
Length of output: 48
Script:
#!/bin/bash
# Check if the migration guide contains the section for 0.7 to 0.8 migration
cat book/src/migrating.md
Length of output: 4837
| ### Added | ||
|
|
||
| - [**breaking**] switch `transform` to a trait (#213) |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Document all breaking changes mentioned in PR objectives.
The changelog only mentions the transform trait change, but the PR objectives indicate additional breaking changes in augurs-core and augurs-forecaster, including removal/renaming of public modules, structs, traits, and enums.
Add these breaking changes to maintain a comprehensive changelog:
### Added
- [**breaking**] switch `transform` to a trait (#213)
+
+### Removed
+
+- [**breaking**] removed/renamed public modules in augurs-core
+- [**breaking**] removed/renamed structs, traits, and enums in augurs-forecaster📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Added | |
| - [**breaking**] switch `transform` to a trait (#213) | |
| ### Added | |
| - [**breaking**] switch `transform` to a trait (#213) | |
| ### Removed | |
| - [**breaking**] removed/renamed public modules in augurs-core | |
| - [**breaking**] removed/renamed structs, traits, and enums in augurs-forecaster |
🤖 New release
augurs: 0.7.0 -> 0.8.0 (✓ API compatible changes)augurs-changepoint: 0.7.0 -> 0.8.0augurs-core: 0.7.0 -> 0.8.0 (augurs-clustering: 0.7.0 -> 0.8.0augurs-dtw: 0.7.0 -> 0.8.0augurs-ets: 0.7.0 -> 0.8.0augurs-mstl: 0.7.0 -> 0.8.0augurs-forecaster: 0.7.0 -> 0.8.0 (augurs-outlier: 0.7.0 -> 0.8.0 (✓ API compatible changes)augurs-prophet: 0.7.0 -> 0.8.0 (✓ API compatible changes)augurs-seasons: 0.7.0 -> 0.8.0augurs-corebreaking changesaugurs-forecasterbreaking changesChangelog
augursaugurs-changepointaugurs-coreaugurs-clusteringaugurs-dtwaugurs-etsaugurs-mstlaugurs-forecasteraugurs-outlieraugurs-prophetaugurs-seasonsThis PR was generated with release-plz.
Summary by CodeRabbit
New Features
transformfunctionality has been switched to a trait.Bug Fixes
box_coxinstead ofboxcox.Documentation
Chores