chore: release v0.6.0 #148
Conversation
WalkthroughThe changes in this pull request primarily involve updating the Changes
Possibly related PRs
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: 0
🧹 Outside diff range and nitpick comments (2)
crates/augurs-prophet/CHANGELOG.md (2)
12-15: Consider enhancing the feature descriptionWhile the addition is documented, consider providing more context about the wasmtime-based optimizer:
- What benefits does it bring?
- Why is a dependency-free implementation important?
- Are there any usage considerations users should be aware of?
### Added -add wasmtime based optimizer for dependency-free Rust impl +- Added wasmtime-based optimizer providing a dependency-free Rust implementation + - Enables standalone operation without external dependencies + - Improves portability and deployment flexibility + - Maintains full compatibility with existing functionality
16-19: Add more specific details about error handling improvementsThe current description is too vague. Consider specifying:
- What aspects of error handling were improved
- What types of errors are now handled better
- Any user-visible impact of these improvements
### Other -Improve error handling in wasmstan optimizer +- Enhanced error handling in wasmstan optimizer: + - Improved error messages for optimization failures + - Added better error recovery mechanisms + - Clearer feedback for configuration issues
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (3)
Cargo.toml(2 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/CHANGELOG.md
🔇 Additional comments (4)
Cargo.toml (3)
15-15: LGTM: Version bump follows semantic versioning.
The version increment from 0.5.4 to 0.5.5 is appropriate for a release with new features that maintain API compatibility.
26-35: LGTM: Dependencies structure is correct.
The dependency declarations correctly specify both version and path, maintaining proper workspace structure.
26-35: Verify version jump from 0.5.3 to 0.5.5.
The dependencies are being updated from 0.5.3 to 0.5.5, skipping 0.5.4. While this might be intentional, let's verify that all crates are prepared for this version jump.
✅ Verification successful
Version update is part of a coordinated release
Based on the changelogs, this is a valid version update. The version jump from 0.5.3 to 0.5.5 is intentional and part of a coordinated release that includes new features:
- The main
augursandaugurs-prophetcrates have already been released as 0.5.5 with the addition of "wasmtime based optimizer for dependency-free Rust impl" - Other crates are being updated to maintain version alignment across the workspace
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify version consistency across all crates
# Test: Check if any crate still references version 0.5.4
echo "Checking for any remaining 0.5.4 references..."
rg "0\.5\.4" crates/
# Test: Verify all crate versions are set to 0.5.5
echo "Verifying crate versions..."
for crate in crates/*/Cargo.toml; do
echo "Checking $crate"
rg "^version = \"0\.5\.5\"" "$crate" || echo "Version mismatch in $crate"
done
Length of output: 4603
Script:
#!/bin/bash
# Let's check the actual versions in the Cargo.toml files
echo "Checking actual versions in Cargo.toml files..."
for crate in crates/*/Cargo.toml; do
echo "=== $crate ==="
rg "^version = " "$crate"
done
# Also check the changelog to understand the version progression
echo -e "\nChecking recent changelog entries..."
for changelog in crates/*/CHANGELOG.md; do
echo "=== $changelog ==="
head -n 20 "$changelog"
done
Length of output: 15886
crates/augurs-prophet/CHANGELOG.md (1)
10-11: LGTM: Version entry follows changelog standards
The version entry is properly formatted with the correct version number, date, and comparison URL.
github-actions
bot
force-pushed
the
release-plz-2024-11-08T08-30-22Z
branch
from
7986f4b
to
7d2f83c
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (3)
Cargo.toml (1)
32-41: Consider adding explicit versions for all workspace crates.While the version updates are consistent for most crates,
augursandaugurs-testingin the workspace dependencies don't specify versions. Consider adding explicit versions to maintain consistency and prevent potential version mismatches.Apply this diff to add versions:
-augurs = { path = "crates/augurs" } +augurs = { version = "0.6.0", path = "crates/augurs" } -augurs-testing = { path = "crates/augurs-testing" } +augurs-testing = { version = "0.6.0", path = "crates/augurs-testing" }crates/augurs-prophet/CHANGELOG.md (2)
12-14: Consider enhancing the feature description.While the addition is significant, consider expanding the description to be more user-friendly and informative:
-add wasmtime based optimizer for dependency-free Rust impl +add wasmtime based optimizer providing a dependency-free Rust implementationAlso consider adding details about:
- The benefits of this new optimizer
- Any performance improvements
- Migration notes if applicable
16-18: Suggest better change categorization and details.Consider the following improvements:
- Move this change to an "Enhanced" or "Changed" section instead of "Other" as it's a clear improvement
- Add more details about the error handling improvements:
-### Other +### Enhanced -Improve error handling in wasmstan optimizer +Improve error handling in wasmstan optimizer: +- [Add specific improvements made to error handling] +- [Add impact on users/developers]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (4)
Cargo.toml(2 hunks)crates/augurs-dtw/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 (1)
- crates/augurs/CHANGELOG.md
🔇 Additional comments (4)
crates/augurs-dtw/CHANGELOG.md (1)
9-10: LGTM: Version entry follows the changelog format.
The version entry is correctly formatted with:
- Proper semantic version (0.6.0)
- Valid comparison URL
- ISO formatted date
Cargo.toml (2)
21-21: LGTM: Version bump is consistent with release objectives.
The workspace version bump to 0.6.0 aligns with the PR objectives and follows semantic versioning.
Line range hint 44-71: Verify dependencies for new features.
The PR mentions a "wasmtime based optimizer" feature, but there's no wasmtime dependency in the workspace dependencies. Please verify if this dependency needs to be added or if it's managed in individual crates.
crates/augurs-prophet/CHANGELOG.md (1)
10-11: LGTM! Version entry follows changelog standards.
The version entry is properly formatted with the correct GitHub compare link and date.
| ### Added | ||
|
|
||
| - [**breaking**] split JS package into separate crates ([#149](https://github.com/grafana/augurs/pull/149)) | ||
|
|
There was a problem hiding this comment.
💡 Codebase verification
Breaking change documentation needs expansion
Based on the evidence from the PR description and code, the breaking change involves splitting the JS package to enable importing specific WASM modules for better bundle size optimization. The changelog should include:
- Motivation: Bundle size optimization by allowing users to import only needed functionality
- Migration steps:
- Update imports from
@bsull/augursto use specific submodules (e.g.,@bsull/augurs/dtwfor DTW functionality) - Each submodule requires its own WASM initialization
- Update imports from
- Example:
- import { Dtw, initSync } from '@bsull/augurs';
+ import { Dtw, initSync } from '@bsull/augurs/dtw';🔗 Analysis chain
Consider expanding the breaking change documentation.
While the breaking change is correctly marked with [**breaking**], consider adding more details about:
- The motivation behind splitting the JS package
- Migration steps for users
- Impact on existing implementations
Let's verify if there are any JS-related files that might need updates:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Look for JS-related files that might need updates
# due to the package split
# Search for package.json files
echo "Searching for package.json files:"
fd package.json
# Search for JS/TS files referencing augurs-dtw
echo -e "\nSearching for JS/TS files using augurs-dtw:"
rg -t js -t ts "augurs-dtw"
Length of output: 314
Script:
#!/bin/bash
# Let's check the PR and commit history for more context about this breaking change
# Check PR description
gh pr view 149 2>/dev/null || true
# Check commit messages related to this change
git log --grep="split.*JS.*package" --grep="augurs-dtw" -i --pretty=format:"%h %s%n%b" 2>/dev/null || true
# Look for any migration guides or documentation
fd -e md -e txt | xargs rg -l "migration|upgrade|breaking.change" 2>/dev/null || true
# Check if there are any examples or tests that might show the before/after usage
fd -e js -e ts -e rs | xargs rg -l "augurs.*dtw" 2>/dev/null || true
Length of output: 2842
Script:
#!/bin/bash
# Let's examine the test files and examples to understand the impact of the change
# Check the test files for usage patterns
echo "=== DTW Test File ==="
cat js/testpkg/dtw.test.ts || true
echo -e "\n=== Example Usage ==="
cat examples/clustering/examples/dbscan_clustering.rs || true
# Check the package structure before and after
echo -e "\n=== Package Template ==="
cat js/package.json.tmpl || true
Length of output: 8894
🤖 New release
augurs: 0.5.4 -> 0.6.0 (✓ API compatible changes)augurs-changepoint: 0.5.4 -> 0.6.0augurs-core: 0.5.4 -> 0.6.0augurs-clustering: 0.5.4 -> 0.6.0augurs-dtw: 0.5.4 -> 0.6.0 (✓ API compatible changes)augurs-ets: 0.5.4 -> 0.6.0augurs-mstl: 0.5.4 -> 0.6.0augurs-forecaster: 0.5.4 -> 0.6.0augurs-outlier: 0.5.4 -> 0.6.0augurs-prophet: 0.5.4 -> 0.6.0 (✓ API compatible changes)augurs-seasons: 0.5.4 -> 0.6.0Changelog
augursaugurs-changepointaugurs-coreaugurs-clusteringaugurs-dtwaugurs-etsaugurs-mstlaugurs-forecasteraugurs-outlieraugurs-prophetaugurs-seasonsThis PR was generated with release-plz.
Summary by CodeRabbit
0.6.0added across multiple projects, documenting new features and improvements.