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.7.0 #178

Merged
merged 2 commits into from
Nov 25, 2024
Merged

chore: release v0.7.0 #178

merged 2 commits into from
Nov 25, 2024

Conversation

sd2k
Copy link
Collaborator

@sd2k sd2k commented Nov 21, 2024

πŸ€– New release

  • augurs: 0.6.3 -> 0.7.0
  • augurs-changepoint: 0.6.3 -> 0.7.0 (βœ“ API compatible changes)
  • augurs-core: 0.6.3 -> 0.7.0
  • augurs-clustering: 0.6.3 -> 0.7.0
  • augurs-dtw: 0.6.3 -> 0.7.0
  • augurs-ets: 0.6.3 -> 0.7.0 (βœ“ API compatible changes)
  • augurs-mstl: 0.6.3 -> 0.7.0 (βœ“ API compatible changes)
  • augurs-forecaster: 0.6.3 -> 0.7.0 (βœ“ API compatible changes)
  • augurs-outlier: 0.6.3 -> 0.7.0 (βœ“ API compatible changes)
  • augurs-prophet: 0.6.3 -> 0.7.0 (⚠️ API breaking changes)
  • augurs-seasons: 0.6.3 -> 0.7.0 (βœ“ API compatible changes)

⚠️ augurs-prophet breaking changes

--- failure inherent_method_missing: pub method removed or renamed ---

Description:
A publicly-visible method or associated fn is no longer available under its prior name. It may have been renamed or removed entirely.
        ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.36.0/src/lints/inherent_method_missing.ron

Failed in:
  Holiday::with_lower_window, previously in file /tmp/.tmpOOOHq5/augurs-prophet/src/features.rs:42
  Holiday::with_upper_window, previously in file /tmp/.tmpOOOHq5/augurs-prophet/src/features.rs:61
Changelog

augurs

0.6.0 - 2024-11-08

Added

  • add wasmtime based optimizer for dependency-free Rust impl

augurs-changepoint

0.7.0 - 2024-11-25

Other

  • update Cargo.toml dependencies

augurs-core

0.5.1 - 2024-10-24

Other

  • define lints in Cargo.toml instead of each crate's lib.rs (#138)

augurs-clustering

0.5.2 - 2024-10-25

Other

  • add benchmark for Prophet (#140)

augurs-dtw

0.6.0 - 2024-11-08

Added

  • [breaking] split JS package into separate crates (#149)

augurs-ets

0.7.0 - 2024-11-25

Other

  • update Cargo.toml dependencies

augurs-mstl

0.7.0 - 2024-11-25

Other

  • update Cargo.toml dependencies

augurs-forecaster

0.7.0 - 2024-11-25

Other

  • update Cargo.toml dependencies

augurs-outlier

0.7.0 - 2024-11-25

Other

  • update Cargo.toml dependencies

augurs-prophet

0.7.0 - 2024-11-25

Added

  • feat!(prophet): support sub-daily & non-UTC holidays (#181)

Fixed

  • add a separate feature for each holiday's lower/upper windows (#179)

Other

  • (deps) update thiserror requirement from 1.0.40 to 2.0.3 (#164)
  • (deps) update wasmtime requirement from 26 to 27 (#183)
  • use u32 instead of i32 for lower/upper windows (#177)

augurs-seasons

0.7.0 - 2024-11-25

Other

  • update Cargo.toml dependencies


This PR was generated with release-plz.

Summary by CodeRabbit

  • New Features
    • Updated workspace package version to 0.7.0, enhancing overall functionality.
    • Introduced support for sub-daily and non-UTC holidays in the augurs-prophet package.
  • Bug Fixes
    • Fixed issues related to holiday feature windows in the augurs-prophet package.
  • Documentation
    • Updated changelogs across multiple packages to reflect version 0.7.0 and dependency updates.

Copy link

cloudflare-workers-and-pages bot commented Nov 21, 2024

Deploying augurs with Β Cloudflare Pages Β Cloudflare Pages

Latest commit: d04a611
Status:Β βœ…Β  Deploy successful!
Preview URL: https://1832422f.augurs.pages.dev
Branch Preview URL: https://release-plz-2024-11-21t16-44.augurs.pages.dev

View logs

Copy link
Contributor

coderabbitai bot commented Nov 21, 2024

Walkthrough

The pull request includes updates to the Cargo.toml file, focusing on version increments for the workspace package and multiple dependencies. The workspace version has been changed from 0.6.3 to 0.7.0, and the versions of several dependencies have also been updated from 0.6.3 to 0.7.0. Additionally, the changelog files for various packages have been revised to reflect the new version and document changes made in the latest release.

Changes

File Change Summary
Cargo.toml - Updated workspace version from 0.6.3 to 0.7.0.
- Updated dependencies from 0.6.3 to 0.7.0 for augurs-changepoint, augurs-clustering, augurs-core, augurs-dtw, augurs-ets, augurs-forecaster, augurs-mstl, augurs-outlier, augurs-prophet, augurs-seasons.
crates/augurs-prophet/CHANGELOG.md - Added entry for version 0.7.0, noting features for sub-daily holidays and data type change for windows.
- Documented changes from previous versions.
crates/augurs-changepoint/CHANGELOG.md - Added entry for version 0.7.0, documenting the update to dependencies.
crates/augurs-ets/CHANGELOG.md - Added entry for version 0.7.0, documenting the update to dependencies.
crates/augurs-forecaster/CHANGELOG.md - Added entry for version 0.7.0, documenting the update to dependencies.
crates/augurs-mstl/CHANGELOG.md - Added entry for version 0.7.0, documenting the update to dependencies.
crates/augurs-outlier/CHANGELOG.md - Added entry for version 0.7.0, documenting the update to dependencies.
crates/augurs-seasons/CHANGELOG.md - Added entry for version 0.7.0, documenting the update to dependencies.

Possibly related PRs

🐰 In the meadow, we hop with glee,
Versions updated, oh what a spree!
Dependencies fresh, like morning dew,
Changelog bright, with changes new.
From 0.6.3 to 0.7.0, we cheer,
A bouncy leap, the future is near! πŸ‡βœ¨


πŸ“œ Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between c67bcef and f41fbf5.

πŸ“’ Files selected for processing (1)
  • crates/augurs-prophet/CHANGELOG.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • crates/augurs-prophet/CHANGELOG.md

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 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

🧹 Outside diff range and nitpick comments (1)
crates/augurs-prophet/CHANGELOG.md (1)

12-14: Consider categorizing the window type change under "Changed" section.

The modification from i32 to u32 for lower/upper windows represents an interface change and would be better categorized under a "Changed" section rather than "Other". This helps users better understand the nature of the modification.

 ## [0.6.4](https://github.com/grafana/augurs/compare/augurs-prophet-v0.6.3...augurs-prophet-v0.6.4) - 2024-11-21
 
-### Other
+### Changed
πŸ“œ Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 4c58635 and d04a611.

πŸ“’ Files selected for processing (2)
  • Cargo.toml (2 hunks)
  • crates/augurs-prophet/CHANGELOG.md (1 hunks)
πŸ”‡ Additional comments (5)
Cargo.toml (3)

21-21: LGTM: Version bump to 0.6.4

The workspace package version update aligns with the release objectives.


32-41: LGTM: Consistent dependency version updates

All augurs-* dependencies are correctly updated to version 0.6.4, maintaining consistency with the workspace version.


32-41: Verify impact of breaking changes

The PR includes breaking changes in augurs-dtw (package split) and augurs-prophet (type changes). While the version updates are correct, we should verify the impact.

βœ… Verification successful

Breaking changes are properly managed through workspace dependencies

The verification shows that all affected packages are properly managed through workspace-level dependencies, and the breaking changes are contained within the workspace:

  • DTW package is used as a workspace dependency in augurs-dtw-js, pyaugurs, and augurs (as an optional feature)
  • Prophet package is used as a workspace dependency in augurs-prophet-js and augurs (as an optional feature)
  • All dependencies use workspace = true, ensuring version consistency
  • The packages using these dependencies are part of the same workspace and will be updated together
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for potential breaking changes impact

# Check for direct usage of augurs-dtw and augurs-prophet
echo "Checking for direct usage of affected packages..."
rg -l "use augurs_(dtw|prophet)" 

# Check Cargo.toml files in workspace for these dependencies
echo "Checking for dependency declarations..."
fd -e toml -x grep -l "augurs-\(dtw\|prophet\)" {}

Length of output: 930


Script:

#!/bin/bash
# Let's check the actual dependency declarations in the affected packages

echo "Checking augurs-dtw dependencies in affected packages..."
for file in ./js/augurs-dtw-js/Cargo.toml ./crates/pyaugurs/Cargo.toml ./crates/augurs/Cargo.toml
do
  echo "=== $file ==="
  grep -A 2 "augurs-dtw" "$file" || true
done

echo -e "\nChecking augurs-prophet dependencies in affected packages..."
for file in ./js/augurs-prophet-js/Cargo.toml ./crates/pyaugurs/Cargo.toml ./crates/augurs/Cargo.toml
do
  echo "=== $file ==="
  grep -A 2 "augurs-prophet" "$file" || true
done

# Let's also check the actual usage patterns to understand the impact
echo -e "\nChecking DTW usage patterns..."
rg "use augurs_dtw" -A 2

echo -e "\nChecking Prophet usage patterns..."
rg "use augurs_prophet" -A 2

Length of output: 6854

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

10-11: LGTM! Version header follows the Keep a Changelog format.

The version header is properly formatted with the correct GitHub comparison link and release date.


14-14: Verify impact of type change from i32 to u32.

The change from signed to unsigned integers for window values could potentially break existing code if negative values were previously accepted.

βœ… Verification successful

Let me gather more information about the window parameter usage and implementation.


Based on the code analysis, I can now provide the final response:

Type change from i32 to u32 for window values is safe and correct

The codebase shows that window values are used in two distinct contexts:

  • Prophet's holiday windows: These represent day offsets and were already using u32, as seen in crates/augurs-prophet/src/features.rs
  • DTW's Sakoe-Chiba windows: These are used for band size constraints and are handled as usize, as seen in crates/augurs-dtw/src/lib.rs

No negative window values are used in tests, examples, or implementation. The windows are consistently used as non-negative values:

  • Holiday windows define observation periods before/after a date
  • DTW windows define band size constraints for warping paths
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any usage of negative window values in tests or examples

# Search for test files containing window-related code
rg -A 5 "window" --glob "**/*test*.{rs,js,ts}"

# Search for example files containing window-related code
rg -A 5 "window" --glob "**/examples/*.{rs,js,ts}"

Length of output: 1328


Script:

#!/bin/bash
# Search for window parameter implementations and usage in source files
rg -A 5 "window.*[:=]" --type rust

# Search for window parameter type definitions
ast-grep --pattern 'struct $_ {
  $$$
  window: $_,
  $$$
}'

# Search for window parameter validation or checks
rg "window" -B 2 -A 2 --glob "**/*.rs"

Length of output: 39617

@github-actions github-actions bot force-pushed the release-plz-2024-11-21T16-44-59Z branch from d04a611 to 24e6c13 Compare November 21, 2024 17:35
@sd2k sd2k changed the title chore: release v0.6.4 chore: release v0.7.0 Nov 22, 2024
@github-actions github-actions bot force-pushed the release-plz-2024-11-21T16-44-59Z branch from 24e6c13 to cfb0295 Compare November 22, 2024 16:19
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: 1

🧹 Outside diff range and nitpick comments (1)
crates/augurs-prophet/CHANGELOG.md (1)

16-18: Consider moving to Added section.

The change "add a separate feature for each holiday's lower/upper windows" appears to be a new feature rather than a bug fix. Consider moving this to the Added section for better changelog organization.

πŸ“œ Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 24e6c13 and cfb0295.

πŸ“’ Files selected for processing (2)
  • Cargo.toml (2 hunks)
  • crates/augurs-prophet/CHANGELOG.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Cargo.toml
πŸ”‡ Additional comments (2)
crates/augurs-prophet/CHANGELOG.md (2)

10-11: LGTM! Version bump follows SemVer.

The version increment to 0.7.0 is appropriate given the breaking changes introduced in this release.


12-14: Verify all breaking changes are documented.

The breaking change for sub-daily & non-UTC holidays support is properly marked with "!" and referenced to PR #181. Let's verify there are no other breaking changes that need documentation.

βœ… Verification successful

Let me gather more specific information about breaking changes by searching through the PR and commit history.


Let me search specifically for any breaking changes in the holiday-related code since that's the focus of the changelog entry.


Based on the search results, I can now generate the final response:

Breaking change for holiday support is properly documented

The breaking change for sub-daily & non-UTC holidays is correctly marked with "!" in the changelog. The code changes show this was indeed a significant change to the holiday API, where:

  • Holidays are now specified using start and end Unix timestamps instead of day-long events
  • The API now supports sub-daily holidays (less than 24 hours)
  • Non-UTC holidays are now supported through explicit timestamp handling
  • Multi-day holidays are now supported

No other breaking changes were found in the codebase that would need documentation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for potential breaking changes in the codebase that might need documentation

# Look for removed or renamed public methods/types
rg -g '!target' -g '!*.md' '(?i)(remove|rename|deprecate|breaking|break).*pub' 

# Look for changes in public API signatures
ast-grep --pattern 'pub $$$'

Length of output: 328


Script:

#!/bin/bash
# Search for breaking changes in commit messages and PR description
gh pr view 181 --json title,body

# Look for any modifications to public interfaces in the prophet crate
rg -g '!target' -g '!*.md' '^pub' crates/augurs-prophet/

# Search for any enum or struct changes that might be breaking
ast-grep --pattern 'pub struct $$$'
ast-grep --pattern 'pub enum $$$'

Length of output: 101127


Script:

#!/bin/bash
# Search for holiday-related changes in the prophet crate
rg -g '!target' -g '!*.md' 'holiday|Holiday' crates/augurs-prophet/

# Look for any changes to holiday-related public interfaces
ast-grep --pattern 'pub $$ Holiday $$'

Length of output: 19615

Comment on lines 20 to 24
### Other

- use u32 instead of i32 for lower/upper windows ([#177](https://github.com/grafana/augurs/pull/177))
Copy link
Contributor

Choose a reason for hiding this comment

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

πŸ› οΈ Refactor suggestion

Move type change to Added section and mark as breaking.

The change from i32 to u32 for lower/upper windows is a breaking change as it modifies a type. Consider:

  1. Moving this to the Added section
  2. Marking it with "!" to indicate a breaking change
 ### Added

 - feat!(prophet): support sub-daily & non-UTC holidays (#181)
+- feat!(prophet): use u32 instead of i32 for lower/upper windows (#177)

 ### Fixed

 - add a separate feature for each holiday's lower/upper windows (#179)

-### Other
-
-- use u32 instead of i32 for lower/upper windows (#177)
πŸ“ 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.

Suggested change
### Other
- use u32 instead of i32 for lower/upper windows ([#177](https://github.com/grafana/augurs/pull/177))
### Added
- feat!(prophet): support sub-daily & non-UTC holidays (#181)
- feat!(prophet): use u32 instead of i32 for lower/upper windows (#177)
### Fixed
- add a separate feature for each holiday's lower/upper windows (#179)

@github-actions github-actions bot force-pushed the release-plz-2024-11-21T16-44-59Z branch from cfb0295 to 3ff6ad2 Compare November 25, 2024 07:30
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: 2

πŸ“œ Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between cfb0295 and 3ff6ad2.

πŸ“’ Files selected for processing (2)
  • Cargo.toml (2 hunks)
  • crates/augurs-prophet/CHANGELOG.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Cargo.toml

Comment on lines 10 to 25
## [0.7.0](https://github.com/grafana/augurs/compare/augurs-prophet-v0.6.3...augurs-prophet-v0.7.0) - 2024-11-25

### Added

- feat!(prophet): support sub-daily & non-UTC holidays ([#181](https://github.com/grafana/augurs/pull/181))

### Fixed

- add a separate feature for each holiday's lower/upper windows ([#179](https://github.com/grafana/augurs/pull/179))

### Other

- *(deps)* update wasmtime requirement from 26 to 27 ([#183](https://github.com/grafana/augurs/pull/183))
- use u32 instead of i32 for lower/upper windows ([#177](https://github.com/grafana/augurs/pull/177))

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Document all breaking changes mentioned in PR objectives

The PR objectives mention removal/renaming of publicly-visible methods, but these breaking changes are not documented in the changelog.

Please add a section documenting all breaking changes, including:

  1. The removal/renaming of publicly-visible methods
  2. The type change from i32 to u32
  3. Any potential breaking changes from the wasmtime update

Example structure:

### Breaking Changes

- Removed/renamed the following public methods: [list the methods]
- Changed type of lower/upper windows from i32 to u32 (#177)
- Updated wasmtime requirement from 26 to 27 (#183)

Comment on lines 20 to 24
### Other

- *(deps)* update wasmtime requirement from 26 to 27 ([#183](https://github.com/grafana/augurs/pull/183))
- use u32 instead of i32 for lower/upper windows ([#177](https://github.com/grafana/augurs/pull/177))
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Move breaking changes to appropriate sections

The type change from i32 to u32 for lower/upper windows is a breaking change and should be moved to the Added section with the "!" prefix. Additionally, the wasmtime dependency update might be breaking and should be documented appropriately.

Apply this diff to reorganize the changes:

 ### Added

 - feat!(prophet): support sub-daily & non-UTC holidays (#181)
+- feat!(prophet): use u32 instead of i32 for lower/upper windows (#177)

 ### Fixed

 - add a separate feature for each holiday's lower/upper windows (#179)

-### Other
+### Dependencies
 
 - *(deps)* update wasmtime requirement from 26 to 27 (#183)
-
-- use u32 instead of i32 for lower/upper windows (#177)
πŸ“ 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.

Suggested change
### Other
- *(deps)* update wasmtime requirement from 26 to 27 ([#183](https://github.com/grafana/augurs/pull/183))
- use u32 instead of i32 for lower/upper windows ([#177](https://github.com/grafana/augurs/pull/177))
### Added
- feat!(prophet): support sub-daily & non-UTC holidays (#181)
- feat!(prophet): use u32 instead of i32 for lower/upper windows (#177)
### Fixed
- add a separate feature for each holiday's lower/upper windows (#179)
### Dependencies
- *(deps)* update wasmtime requirement from 26 to 27 (#183)

@github-actions github-actions bot force-pushed the release-plz-2024-11-21T16-44-59Z branch from 3ff6ad2 to 0b9e8af Compare November 25, 2024 07:34
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: 2

πŸ“œ Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 3ff6ad2 and 0b9e8af.

πŸ“’ Files selected for processing (8)
  • Cargo.toml (2 hunks)
  • crates/augurs-changepoint/CHANGELOG.md (1 hunks)
  • crates/augurs-ets/CHANGELOG.md (1 hunks)
  • crates/augurs-forecaster/CHANGELOG.md (1 hunks)
  • crates/augurs-mstl/CHANGELOG.md (1 hunks)
  • crates/augurs-outlier/CHANGELOG.md (1 hunks)
  • crates/augurs-prophet/CHANGELOG.md (1 hunks)
  • crates/augurs-seasons/CHANGELOG.md (1 hunks)
βœ… Files skipped from review due to trivial changes (5)
  • crates/augurs-changepoint/CHANGELOG.md
  • crates/augurs-forecaster/CHANGELOG.md
  • crates/augurs-mstl/CHANGELOG.md
  • crates/augurs-outlier/CHANGELOG.md
  • crates/augurs-seasons/CHANGELOG.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • Cargo.toml
πŸ”‡ Additional comments (2)
crates/augurs-ets/CHANGELOG.md (1)

9-14: Verify version consistency across workspace packages.

Since this is part of a coordinated release across multiple components, let's ensure version consistency.

βœ… Verification successful

Version consistency verified across workspace packages

The workspace is properly configured with version consistency. All packages inherit the workspace version (0.7.0) through version.workspace = true, and the workspace dependencies section correctly specifies version 0.7.0 for all augurs packages. The CHANGELOG.md update is consistent with the workspace-wide version.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check version consistency across workspace packages

# Find all Cargo.toml files and check their versions
fd Cargo.toml -x grep -H '^version = ' {} \;

# Verify that related augurs packages are at version 0.7.0
fd Cargo.toml -x grep -H 'augurs-[a-z]* = "0\.7\.0"' {} \;

Length of output: 144


Script:

#!/bin/bash
# Let's check the workspace members and their versions more thoroughly

# First, let's see if this is a workspace by checking the root Cargo.toml
echo "=== Root Cargo.toml workspace members ==="
rg "members\s*=" Cargo.toml -A 5

# Now let's check versions in all Cargo.toml files with more context
echo -e "\n=== All Cargo.toml versions with context ==="
fd Cargo.toml -x sh -c 'echo "=== {} ==="; cat {}' \;

Length of output: 25409

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

10-24: ⚠️ Potential issue

Document missing breaking changes mentioned in PR objectives.

The PR objectives mention removal/renaming of publicly-visible methods, but these breaking changes are not documented in the changelog. This documentation is crucial for users to understand API compatibility changes.

Please document all removed or renamed public methods in the Breaking Changes section. For example:

 ## [0.7.0](https://github.com/grafana/augurs/compare/augurs-prophet-v0.6.3...augurs-prophet-v0.7.0) - 2024-11-25

 ### Breaking Changes
 
 - Changed type of lower/upper windows from `i32` to `u32` ([#177](https://github.com/grafana/augurs/pull/177))
+- Removed/renamed the following public methods:
+  - [List the removed methods]
+  - [List the renamed methods with their old and new names]

Let's verify the removed/renamed methods:

Comment on lines +9 to +14
## [0.7.0](https://github.com/grafana/augurs/compare/augurs-ets-v0.6.3...augurs-ets-v0.7.0) - 2024-11-25

### Other

- update Cargo.toml dependencies

Copy link
Contributor

Choose a reason for hiding this comment

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

πŸ’‘ Codebase verification

The changelog entry needs more specific details about dependency updates

The changelog should mention these specific dependency updates:

  • lstsq at version "0.6.0"
  • nalgebra at version "0.33.0"
  • rand_distr at version "0.4.3"
  • Several workspace-managed dependencies updated to version "0.7.0"

Additionally, since this is a minor version bump (0.6.3 to 0.7.0), it would be helpful to note if any of these dependency updates introduce new features or potential behavioral changes.

πŸ”— Analysis chain

Enhance the changelog entry with more specific details.

The current changelog entry is quite minimal. Consider adding:

  • Specific dependencies that were updated
  • Version changes for each dependency
  • Any potential impact of these updates

Let's verify the dependency updates:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Compare dependency versions between 0.6.3 and 0.7.0

# Get the Cargo.toml changes between versions
git diff augurs-ets-v0.6.3..augurs-ets-v0.7.0 -- crates/augurs-ets/Cargo.toml

Length of output: 138


Script:

#!/bin/bash
# Let's first check if the tags exist and their correct names
git tag | grep -i "augurs-ets"

# Also, let's check the Cargo.toml directly to see the dependency changes
cat crates/augurs-ets/Cargo.toml

Length of output: 1026


Script:

#!/bin/bash
# Let's check the workspace Cargo.toml for version information
cat Cargo.toml

# And let's check git history for recent changes to the dependencies
git log -p --no-merges -n 1 -- crates/augurs-ets/Cargo.toml

Length of output: 2693

@sd2k sd2k enabled auto-merge (squash) November 25, 2024 08:17
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: 3

πŸ“œ Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between 0b9e8af and c67bcef.

πŸ“’ Files selected for processing (1)
  • crates/augurs-prophet/CHANGELOG.md (1 hunks)


### Added

- feat!(prophet): support sub-daily & non-UTC holidays ([#181](https://github.com/grafana/augurs/pull/181))
Copy link
Contributor

Choose a reason for hiding this comment

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

πŸ› οΈ Refactor suggestion

Use consistent breaking change markers

The feature is marked with "!" to indicate a breaking change, but it's not listed in the Breaking Changes section.

Either:

  1. Move this to the Breaking Changes section, or
  2. Add a note in the Breaking Changes section referencing this feature

Comment on lines 12 to 15
### Breaking Changes

- Changed type of lower/upper windows from `i32` to `u32` ([#177](https://github.com/grafana/augurs/pull/177))
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Document all breaking changes mentioned in PR objectives

The PR objectives mention removal/renaming of publicly-visible methods as breaking changes, but these aren't documented in the changelog. Please add these breaking changes to maintain a complete record.

Add the removed/renamed methods to the Breaking Changes section:

 ### Breaking Changes

+- Removed/renamed the following public methods:
+  - [List the removed methods]
+  - [List the renamed methods with their old and new names]
 - Changed type of lower/upper windows from `i32` to `u32` ([#177](https://github.com/grafana/augurs/pull/177))

Committable suggestion skipped: line range outside the PR's diff.

Comment on lines +24 to +25
### Dependencies

- *(deps)* update thiserror requirement from 1.0.40 to 2.0.3 ([#164](https://github.com/grafana/augurs/pull/164))
- *(deps)* update wasmtime requirement from 26 to 27 ([#183](https://github.com/grafana/augurs/pull/183))
Copy link
Contributor

Choose a reason for hiding this comment

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

πŸ’‘ Codebase verification

Consider marking wasmtime update as breaking

Based on the codebase analysis, wasmtime is a critical dependency used for running the Prophet model inside WebAssembly components. The update from v26 to v27 should be marked as a breaking change because:

  1. Wasmtime is used extensively in wasmstan.rs for core functionality including component compilation, linking, and runtime execution
  2. The codebase directly interfaces with wasmtime's API through multiple features:
    • Component system
    • WASI integration
    • Store management
    • Error handling
  3. Major version bumps (26 to 27) in such a foundational dependency typically include breaking API changes
  • Move the wasmtime update from "Dependencies" to "Breaking Changes" section in crates/augurs-prophet/CHANGELOG.md
πŸ”— Analysis chain

Consider marking wasmtime update as breaking

The update of wasmtime from version 26 to 27 could potentially introduce breaking changes. Consider moving this to the Breaking Changes section if it includes any backwards-incompatible changes.

Let's verify if this is a breaking change:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for breaking changes in wasmtime v27

# Check the wasmtime changelog for breaking changes
gh api repos/bytecodealliance/wasmtime/releases | \
  jq -r '.[] | select(.tag_name | startswith("v27.")) | .body' | \
  grep -i "breaking"

Length of output: 131


Script:

#!/bin/bash
# Let's try to find any usage of wasmtime in the codebase to understand its impact

# Find files containing wasmtime
rg -l "wasmtime"

# Search for wasmtime dependency declaration in Cargo.toml files
rg "wasmtime.*=.*\".*\"" --type toml

# Look for any wasmtime-related imports or uses
rg "use.*wasmtime" -A 2

Length of output: 1232


Script:

#!/bin/bash
# Let's examine the wasmstan.rs file to understand how wasmtime is used
cat crates/augurs-prophet/src/wasmstan.rs

# Also check the justfile for any wasmtime-related build or test commands
cat components/justfile

Length of output: 13362

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@sd2k sd2k force-pushed the release-plz-2024-11-21T16-44-59Z branch from c67bcef to f41fbf5 Compare November 25, 2024 08:24
@sd2k sd2k merged commit 84399ed into main Nov 25, 2024
23 checks passed
@sd2k sd2k deleted the release-plz-2024-11-21T16-44-59Z branch November 25, 2024 08:38
This was referenced Dec 23, 2024
@coderabbitai coderabbitai bot mentioned this pull request Jan 6, 2025
@coderabbitai coderabbitai bot mentioned this pull request Jan 14, 2025
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