Skip to content
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

chore: release v0.9.0 #232

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: release v0.9.0 #232

wants to merge 1 commit into from

Conversation

sd2k
Copy link
Collaborator

@sd2k sd2k commented Jan 11, 2025

πŸ€– New release

  • augurs: 0.8.1 -> 0.9.0 (βœ“ API compatible changes)
  • augurs-changepoint: 0.8.1 -> 0.9.0
  • augurs-core: 0.8.1 -> 0.9.0 (βœ“ API compatible changes)
  • augurs-clustering: 0.8.1 -> 0.9.0 (βœ“ API compatible changes)
  • augurs-dtw: 0.8.1 -> 0.9.0 (βœ“ API compatible changes)
  • augurs-ets: 0.8.1 -> 0.9.0
  • augurs-mstl: 0.8.1 -> 0.9.0
  • augurs-forecaster: 0.8.1 -> 0.9.0 (βœ“ API compatible changes)
  • augurs-outlier: 0.8.1 -> 0.9.0 (βœ“ API compatible changes)
  • augurs-prophet: 0.8.1 -> 0.9.0 (βœ“ API compatible changes)
  • augurs-seasons: 0.8.1 -> 0.9.0
Changelog

augurs

0.9.0 - 2025-01-12

Other

augurs-changepoint

0.8.1 - 2025-01-07

Other

  • update Cargo.toml dependencies

augurs-core

0.9.0 - 2025-01-12

Added

augurs-clustering

0.9.0 - 2025-01-12

Other

augurs-dtw

0.9.0 - 2025-01-12

Added

augurs-ets

0.8.1 - 2025-01-07

Other

  • update Cargo.toml dependencies

augurs-mstl

0.7.0 - 2024-11-25

Other

  • update Cargo.toml dependencies

augurs-forecaster

0.9.0 - 2025-01-12

Added

augurs-outlier

0.9.0 - 2025-01-12

Added

augurs-prophet

0.9.0 - 2025-01-12

Added

augurs-seasons

0.8.1 - 2025-01-07

Other

  • update Cargo.toml dependencies


This PR was generated with release-plz.

Summary by CodeRabbit

  • Version Update
    • Upgraded project and all augurs dependencies from version 0.8.1 to 0.9.0
  • New Features
    • Added NaN handling for MinMaxScaler and StandardScaler components
  • Breaking Changes
    • Introduced new DbscanCluster type replacing isize in clustering functionality

Copy link
Contributor

coderabbitai bot commented Jan 11, 2025

Walkthrough

This pull request updates the versioning across the Augurs workspace, incrementing the main package and all related dependencies from 0.8.1 to 0.9.0. The changes include the addition of NaN handling for MinMaxScaler and StandardScaler components, addressing issue #227. Each crate's changelog has been updated to reflect these changes, ensuring consistent documentation for the new version.

Changes

File Change Summary
Cargo.toml - Workspace package version updated from 0.8.1 to 0.9.0
- All Augurs dependencies updated to version 0.9.0
crates/*/CHANGELOG.md - Added version 0.9.0 entry
- Documented NaN handling for MinMaxScaler and StandardScaler (#227)
- Noted breaking change for DbscanCluster in augurs-clustering and augurs

Possibly related PRs

  • chore: releaseΒ #96: This PR involves a similar update to the Cargo.toml file, where the versions of the main package and its dependencies were incremented, indicating a coordinated release strategy.
  • chore: release v0.4.1Β #132: This PR also updates the Cargo.toml file for the workspace and its dependencies, reflecting a consistent versioning strategy similar to the main PR.
  • chore: release v0.5.1Β #139: This PR updates the Cargo.toml file for the workspace and its dependencies, maintaining the versioning consistency seen in the main PR.

Poem

🐰 A Leap to Version Nine
From eight to nine, we hop with glee,
NaNs handled well, oh what a spree!
Scalers refined, with care they grow,
In Augurs' world, the updates flow.
A rabbit's cheer for code so bright,
Versioning joy, a coder's delight! πŸš€


πŸ“œ Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between bc00d91 and 09d648c.

πŸ“’ Files selected for processing (8)
  • Cargo.toml (2 hunks)
  • crates/augurs-clustering/CHANGELOG.md (1 hunks)
  • crates/augurs-core/CHANGELOG.md (1 hunks)
  • crates/augurs-dtw/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 as they are similar to previous changes (4)
  • crates/augurs-outlier/CHANGELOG.md
  • crates/augurs-dtw/CHANGELOG.md
  • crates/augurs-core/CHANGELOG.md
  • crates/augurs-prophet/CHANGELOG.md
πŸ”‡ Additional comments (5)
Cargo.toml (1)

21-21: Version updates look consistent!

All package versions have been correctly updated from 0.8.1 to 0.9.0, maintaining consistency across the workspace.

Also applies to: 32-41

crates/augurs-clustering/CHANGELOG.md (1)

9-14: Breaking change is well-documented

The breaking change to use the new DbscanCluster type is properly documented and marked. Since this is a breaking change, please ensure there's a migration guide available for users.

Run this script to check for migration guide documentation:

βœ… Verification successful

Breaking change is sufficiently documented

The breaking change from isize to DbscanCluster is a straightforward type change that:

  • Improves type safety by using an enum with NonZeroU32 for cluster IDs
  • Provides better semantics for noise detection
  • Is clearly documented in both the changelog and PR description

No separate migration guide is needed as the change is a simple type replacement with clear semantics.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for migration guide documentation
echo "Checking for migration guide..."
rg -l "migrating.*from.*0\.8.*0\.9" docs/ || \
fd -g "*.md" -x rg -l "migrating.*from.*0\.8.*0\.9" {} \;

Length of output: 225


Script:

#!/bin/bash
# Search for migration guide or upgrade instructions
echo "Checking README and documentation files..."
# Look for README files
fd -g "README*.md" -x cat {}

# Search for migration or upgrade related content
rg -i "(migration|upgrade|breaking.?change).*DbscanCluster" -A 5

# Check source documentation in the clustering module
fd -g "*.rs" -p "crates/augurs-clustering/src" -x cat {}

Length of output: 42480


Script:

#!/bin/bash
# Check PR #233 and implementation files
# Look for the PR title and description
gh pr view 233 2>/dev/null || true

# Check the implementation files for the type change
ast-grep --pattern 'struct DbscanCluster'
ast-grep --pattern 'enum DbscanCluster'

Length of output: 1541

crates/augurs/CHANGELOG.md (1)

10-14: Breaking change properly propagated to main package

The breaking change from the clustering module is correctly documented in the main package's changelog.

crates/augurs-forecaster/CHANGELOG.md (2)

Line range hint 21-21: Version release looks ready for deployment

The v0.9.0 release is well-prepared with:

  1. Consistent version updates across all packages
  2. Well-documented breaking change in clustering module
  3. Clear documentation of new NaN handling feature
  4. Proper changelog entries following the Keep a Changelog format

Remember to ensure the migration guide is available for the breaking change in the clustering module.

Also applies to: 9-9, 10-10, 9-9


9-14: Feature addition is well-documented

The NaN handling feature for MinMaxScaler and StandardScaler is properly documented. Let's verify the implementation details.

Run this script to check the implementation:

βœ… Verification successful

NaN handling implementation verified

The NaN handling feature is properly implemented in both scalers:

  • MinMaxScaler filters NaNs during computation while preserving them in output
  • StandardScaler provides explicit NaN handling with ignore_nans option
  • Comprehensive test coverage confirms correct behavior for both transform and inverse operations
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for NaN handling implementation in scalers
echo "Checking MinMaxScaler and StandardScaler implementations..."
ast-grep --pattern 'impl $_Scaler {
  $$$
  fn $_($_, nan: $_) {
    $$$
  }
  $$$
}'

# Check for tests
echo "Checking for NaN handling tests..."
rg -A 5 "test.*nan" "crates/augurs-forecaster/src"

Length of output: 346


Script:

#!/bin/bash
# Check for scaler implementations with NaN handling
echo "Checking MinMaxScaler implementation..."
rg -A 10 "impl MinMaxScaler" "crates/augurs-forecaster/src"

echo "Checking StandardScaler implementation..."
rg -A 10 "impl StandardScaler" "crates/augurs-forecaster/src"

echo "Checking for NaN-related code..."
rg -A 5 "is_nan|f64::NAN" "crates/augurs-forecaster/src"

echo "Checking for NaN-related tests..."
rg -A 5 "#\[test\].*nan|test_.*nan" "crates/augurs-forecaster/src/**/*.rs"

Length of output: 13131


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?

❀️ Share
πŸͺ§ Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
crates/augurs-dtw/CHANGELOG.md (1)

13-13: Remove incorrect component prefix in changelog entry.

The *(forecaster)* prefix seems out of place in the augurs-dtw crate's changelog. This prefix suggests the feature belongs to the forecaster component, which might confuse users looking for DTW-specific changes.

-*(forecaster)* add NaN handling to MinMaxScaler and StandardScaler (#227)
+add NaN handling to MinMaxScaler and StandardScaler (#227)
crates/augurs-outlier/CHANGELOG.md (1)

13-13: Remove incorrect component prefix in changelog entry.

The *(forecaster)* prefix is incorrectly included in the augurs-outlier crate's changelog. This prefix should be removed to maintain consistency with the component's scope.

-*(forecaster)* add NaN handling to MinMaxScaler and StandardScaler (#227)
+add NaN handling to MinMaxScaler and StandardScaler (#227)
crates/augurs-core/CHANGELOG.md (1)

13-13: Remove incorrect component prefix in changelog entry.

The *(forecaster)* prefix should be removed from the augurs-core crate's changelog as it incorrectly suggests this is a forecaster-specific change.

-*(forecaster)* add NaN handling to MinMaxScaler and StandardScaler (#227)
+add NaN handling to MinMaxScaler and StandardScaler (#227)
πŸ“œ Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between e098590 and bc00d91.

πŸ“’ Files selected for processing (6)
  • Cargo.toml (2 hunks)
  • crates/augurs-core/CHANGELOG.md (1 hunks)
  • crates/augurs-dtw/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)
⏰ Context from checks skipped due to timeout of 90000ms (21)
  • GitHub Check: macos (macos-14, aarch64)
  • GitHub Check: macos (macos-13, x86_64)
  • GitHub Check: windows (windows-latest, x86)
  • GitHub Check: windows (windows-latest, x64)
  • GitHub Check: linux (ubuntu-22.04, ppc64le)
  • GitHub Check: musllinux (ubuntu-22.04, armv7)
  • GitHub Check: linux (ubuntu-22.04, s390x)
  • GitHub Check: linux (ubuntu-22.04, armv7)
  • GitHub Check: musllinux (ubuntu-22.04, aarch64)
  • GitHub Check: linux (ubuntu-22.04, aarch64)
  • GitHub Check: Test Book
  • GitHub Check: musllinux (ubuntu-22.04, x86)
  • GitHub Check: Tests
  • GitHub Check: linux (ubuntu-22.04, x86)
  • GitHub Check: Rustfmt
  • GitHub Check: musllinux (ubuntu-22.04, x86_64)
  • GitHub Check: Clippy
  • GitHub Check: linux (ubuntu-22.04, x86_64)
  • GitHub Check: Prophet WASMStan component
  • GitHub Check: JS tests
  • GitHub Check: Check
πŸ”‡ Additional comments (4)
Cargo.toml (1)

21-21: LGTM! Version updates are consistent.

The version bump to 0.8.2 is consistently applied across the workspace package and all augurs-* dependencies.

Also applies to: 32-41

crates/augurs-forecaster/CHANGELOG.md (1)

13-13: LGTM! Changelog entry is correctly formatted.

The changelog entry is properly formatted with the correct component prefix, as this is the forecaster crate where the NaN handling feature was implemented.

crates/augurs-prophet/CHANGELOG.md (2)

10-11: Verify the comparison link for version 0.8.2

The version comparison link appears to be correctly formatted, but let's verify it resolves properly.

βœ… Verification successful

The 404 error for the comparison link is expected

The changelog entry is for an upcoming release (v0.8.2) scheduled for January 11, 2025. The comparison link will work once the tag augurs-prophet-v0.8.2 is created during the release process. The current latest version is v0.8.1, released on January 7, 2025.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the comparison link for version 0.8.2 resolves properly
# Expected: Link should return a 200 status code

curl -s -o /dev/null -w "%{http_code}" "https://github.com/grafana/augurs/compare/augurs-prophet-v0.8.1...augurs-prophet-v0.8.2"

Length of output: 132


Script:

#!/bin/bash
# List tags containing "prophet" to understand the naming pattern
git tag | grep -i "prophet"

# Show 5 most recent tags to verify the current format
git tag --sort=-creatordate | head -n 5

Length of output: 69


Script:

#!/bin/bash
# Fetch all tags
git fetch --tags

# List tags again
git tag | grep -i "prophet"

# Check releases through GitHub API
gh release list --repo grafana/augurs --limit 5

Length of output: 17733


12-14: Verify consistency of NaN handling changes across components

The addition of NaN handling is documented consistently with the forecaster prefix. Let's verify this change is documented similarly across all affected components.

βœ… Verification successful

NaN handling changes are consistently documented

The NaN handling changes for MinMaxScaler and StandardScaler are properly documented across all affected components (core, forecaster, and prophet) with consistent "(forecaster)" prefix and PR reference (#227).

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify NaN handling documentation across components
# Expected: Similar entries should exist in other component changelogs

# Search for similar NaN handling entries in other component changelogs
rg -l "add NaN handling to MinMaxScaler and StandardScaler" "crates/*/CHANGELOG.md"

Length of output: 147


Script:

#!/bin/bash
# First, find all CHANGELOG.md files
echo "=== Searching for CHANGELOG.md files ==="
fd -t f "CHANGELOG.md$"

# Then, find implementations of MinMaxScaler and StandardScaler
echo -e "\n=== Searching for Scaler implementations ==="
ast-grep --pattern 'struct $_(MinMaxScaler|StandardScaler)'

# Search for any NaN-related entries in changelogs with context
echo -e "\n=== Searching for NaN-related entries in changelogs ==="
rg -i "nan" -A 2 "CHANGELOG.md"

Length of output: 930


Script:

#!/bin/bash
# Search for NaN-related entries in all changelogs
echo "=== Searching for NaN-related entries in changelogs ==="
rg -i "nan" "crates/*/CHANGELOG.md"

# Look for Scaler implementations with a more flexible pattern
echo -e "\n=== Searching for Scaler implementations ==="
ast-grep --pattern 'struct $_Scaler'

# Search specifically in forecaster-related files
echo -e "\n=== Searching in forecaster files ==="
rg -l "Scaler" "crates/augurs-forecaster/**/*"

Length of output: 570


Script:

#!/bin/bash
# Search for NaN-related entries in changelogs
echo "=== Searching for NaN-related entries in changelogs ==="
rg -i "nan" crates/augurs-prophet/CHANGELOG.md crates/augurs-forecaster/CHANGELOG.md crates/augurs-core/CHANGELOG.md

# Look for Scaler implementations
echo -e "\n=== Searching for Scaler implementations ==="
fd -e rs . crates/augurs-forecaster crates/augurs-core | xargs rg "Scaler" -A 5

Length of output: 17437

@sd2k sd2k changed the title chore: release v0.8.2 chore: release v0.9.0 Jan 12, 2025
@github-actions github-actions bot force-pushed the release-plz-2025-01-11T13-24-15Z branch from bc00d91 to 09d648c Compare January 12, 2025 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant