chore: release v0.4.0 #123
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThe changes in this pull request involve updates to the Changes
Possibly related PRs
Suggested labels
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: 4
🧹 Outside diff range and nitpick comments (8)
crates/augurs/CHANGELOG.md (2)
8-9: LGTM: "Unreleased" section presentThe inclusion of an "Unreleased" section is good practice. It's currently empty, which is fine if there are no unreleased changes.
Consider adding a placeholder comment (e.g., "No unreleased changes at this time.") to make it clear that the section is intentionally empty.
10-14: LGTM: Well-formatted version entryThe version 0.4.0 entry is well-structured and informative. It includes the version number, release date, a comparison link, and clearly documents the addition of the 'augurs' convenience crate with a reference to the relevant pull request.
Consider adding a brief description of what the 'augurs' convenience crate does or why it was added. This would provide more context for users reading the changelog.
crates/augurs-clustering/CHANGELOG.md (1)
15-16: Consider removing redundant entryThe entry "Add
augurs-clusteringcrate" in the "Other" section appears to be redundant. This information is already covered in the "Added" section with more detail and a link to the pull request.Consider removing this line to avoid duplication:
-### Other -- Add `augurs-clustering` crateThis will keep the changelog concise and prevent potential confusion.
🧰 Tools
🪛 LanguageTool
[misspelling] ~16-~16: It seems that the plural noun “others” fits better in this context.
Context: ...thub.com//pull/100)) ### Other - Addaugurs-clusteringcrate(OTHER_OTHERS)
crates/augurs-dtw/CHANGELOG.md (1)
11-16: LGTM: Added features are well-documented.The "Added" section accurately reflects the new features, including those mentioned in the PR objectives and some additional improvements. Each item is properly linked to its corresponding pull request.
Consider rewording the last item for consistency:
- add `augurs-dtw` crate with dynamic time warping implementation ([#98](https://github.com/grafana/augurs/pull/98)) + add `augurs-dtw` crate implementing dynamic time warping ([#98](https://github.com/grafana/augurs/pull/98))crates/augurs-changepoint/CHANGELOG.md (1)
9-9: Update the release dateThe release date is set to 2024-10-10, which is in the future. Consider updating it to the actual release date or removing the date if the release is not yet finalized.
You can update the date using the following diff:
-## [0.4.0](https://github.com/grafana/augurs/compare/augurs-changepoint-v0.3.1...augurs-changepoint-v0.4.0) - 2024-10-10 +## [0.4.0](https://github.com/grafana/augurs/compare/augurs-changepoint-v0.3.1...augurs-changepoint-v0.4.0) - 2024-10-09Or remove the date if the release is not yet finalized:
-## [0.4.0](https://github.com/grafana/augurs/compare/augurs-changepoint-v0.3.1...augurs-changepoint-v0.4.0) - 2024-10-10 +## [0.4.0](https://github.com/grafana/augurs/compare/augurs-changepoint-v0.3.1...augurs-changepoint-v0.4.0)crates/augurs-testing/CHANGELOG.md (1)
9-13: LGTM! Consider adding more details about the 'augurs' crate.The new version entry for 0.4.0 is well-formatted and consistent with the PR objectives. It correctly follows the Keep a Changelog format and includes the appropriate link for version comparison.
Consider expanding on the description of the 'augurs' convenience crate. For example, you could mention which specific crates it re-exports or any benefits it provides to users. This additional information could be valuable for users reading the changelog.
crates/augurs-mstl/CHANGELOG.md (1)
9-14: LGTM! Consider adding release date.The new changelog entries for version 0.4.0 are well-formatted and align with the PR objectives. They provide clear, concise information about the additions in this release, including links to the relevant pull requests.
Consider updating the release date from "2024-10-10" to the actual release date, as this appears to be a future date.
crates/augurs-ets/CHANGELOG.md (1)
9-13: Consider expanding the changelog entry to include all relevant changes.The new changelog entry for version 0.4.0 is a good start, but it may be missing some important information:
The PR objectives mentioned breaking changes for
augurs-ets, such as the removal or renaming of publicly-visible modules and constants. These should be documented in the changelog under a "Breaking Changes" section.Consider adding more details about the 'augurs' convenience crate. What specific benefits does it provide to users?
Are there any other changes, improvements, or bug fixes that should be mentioned?
Remember, a comprehensive changelog helps users understand what's new and what might affect their existing code.
Would you like assistance in drafting a more detailed changelog entry?
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (12)
- Cargo.toml (2 hunks)
- crates/augurs-changepoint/CHANGELOG.md (1 hunks)
- crates/augurs-clustering/CHANGELOG.md (1 hunks)
- crates/augurs-core/CHANGELOG.md (1 hunks)
- crates/augurs-dtw/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-seasons/CHANGELOG.md (1 hunks)
- crates/augurs-testing/CHANGELOG.md (1 hunks)
- crates/augurs/CHANGELOG.md (1 hunks)
✅ Files skipped from review due to trivial changes (2)
- crates/augurs-forecaster/CHANGELOG.md
- crates/augurs-seasons/CHANGELOG.md
🧰 Additional context used
🔇 Additional comments (15)
crates/augurs/CHANGELOG.md (2)
1-6: LGTM: Well-structured changelog headerThe header of the changelog is well-structured and follows best practices. It clearly identifies the file's purpose and adheres to established standards (Keep a Changelog and Semantic Versioning).
1-14: Overall: Well-structured and informative changelogThis changelog is well-structured, follows best practices, and effectively communicates the changes in version 0.4.0. It adheres to the Keep a Changelog format and Semantic Versioning principles, which is excellent. The minor suggestions provided earlier would further enhance its clarity, but overall, this is a high-quality changelog that serves its purpose well.
crates/augurs-clustering/CHANGELOG.md (2)
9-10: Verify the release dateThe release date is set to 2024-10-10, which is in the future. Typically, changelogs use the current date or leave the date blank for unreleased versions.
Please confirm if this future date is intentional or if it should be updated to the current date or removed.
11-14: LGTM: Clear and informative additionsThe "Added" section clearly documents the new features introduced in this version:
- The 'augurs' convenience crate for re-exporting other crates.
- The augurs-clustering crate with DBSCAN algorithm.
Both entries include links to their respective pull requests, which is helpful for tracking the origin of these changes.
crates/augurs-dtw/CHANGELOG.md (2)
9-9: LGTM: Version number and comparison link are correct.The new version entry (0.4.0) and the comparison link are correctly formatted and aligned with the PR objectives.
9-9: LGTM: Release date is correct and properly formatted.The release date (2024-10-10) is correctly formatted and consistent with the current timeframe.
crates/augurs-changepoint/CHANGELOG.md (1)
9-14: LGTM: New version entry follows CHANGELOG conventionsThe new version entry for 0.4.0 is well-structured and follows the Keep a Changelog conventions. It includes a comparison link to the previous version and clearly documents the addition of the new 'augurs' convenience crate with a reference to the related pull request.
Cargo.toml (1)
Line range hint
1-14: Consider checking for updates to external dependenciesWhile the augurs ecosystem dependencies have been updated, it might be beneficial to check if there are any updates available for external dependencies like distrs, itertools, roots, etc. This could potentially bring in bug fixes or performance improvements.
Check for available updates to external dependencies:
Also applies to: 16-24, 36-55
crates/augurs-outlier/CHANGELOG.md (4)
9-9: Verify the release dateThe release date is set to 2024-10-10, which is in the future. Typically, changelog entries use the current date or the date when the release is actually made.
Please confirm if this future date is intentional or if it should be updated to the current date.
11-13: LGTM: New convenience crate addedThe addition of the 'augurs' convenience crate that re-exports other crates is well-documented and aligns with the PR objectives.
15-18: LGTM: Breaking changes well-documentedThe "Fixed" section clearly documents two breaking changes:
- Addition of serde derives for more types.
- Making
cluster_bandoptional, with a clear explanation of the new behavior.These changes align with the PR objectives and are properly marked as breaking.
To ensure these breaking changes are properly communicated to users, please confirm that:
- The major version number has been incremented (which is the case here, from 0.3.1 to 0.4.0).
- These breaking changes are highlighted in any release notes or announcements accompanying this version.
9-18: Overall: Well-structured and informative changelog entryThe changelog entry for version 0.4.0 is comprehensive and follows the Keep a Changelog format. It accurately reflects the changes mentioned in the PR objectives, including the addition of the new convenience crate and the breaking changes in the
augurs-outliercrate.Some points to note:
- The release date is set in the future, which may need verification.
- Breaking changes are clearly marked and explained.
- Links to relevant pull requests are provided for each change.
This level of detail in the changelog is commendable and will be valuable for users upgrading to this new version.
crates/augurs-core/CHANGELOG.md (3)
9-9: Verify the release dateThe release date is set to 2024-10-10, which is in the future. Please confirm if this is intentional or if it should be updated to the current date.
11-15: LGTM: Clear and concise additionsThe "Added" section clearly outlines the new features introduced in this version. The additions align with the PR objectives and provide good traceability with pull request numbers.
9-20: LGTM: Well-structured and informative changelog entryThe new changelog entry for version 0.4.0 is well-structured and informative. It follows the established format, provides a clear overview of the changes, and enhances traceability by including pull request references. The categorization of changes into "Added" and "Fixed" sections helps users quickly understand the nature of the updates.
| - derive Clone for Dtw ([#114](https://github.com/grafana/augurs/pull/114)) | ||
| - parallel DTW calculations in augurs-js ([#111](https://github.com/grafana/augurs/pull/111)) | ||
| - add `augurs-dtw` crate with dynamic time warping implementation ([#98](https://github.com/grafana/augurs/pull/98)) | ||
|
|
There was a problem hiding this comment.
Remove redundant "Other" section.
The "Other" section contains a single item that is already covered in the "Added" section. To avoid redundancy and maintain a clean changelog, consider removing this section entirely.
Apply this diff to remove the redundant section:
-### Other
-- Add `augurs-dtw` crateCommittable suggestion was skipped due to low confidence.
| ### Fixed | ||
|
|
||
| - [**breaking**] add serde derives for more types ([#112](https://github.com/grafana/augurs/pull/112)) |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider moving breaking change to a "Changed" section
The breaking change (adding serde derives for more types) is correctly marked as breaking. However, it's currently listed under the "Fixed" section, which might be misleading. Consider moving this item to a new "Changed" section to better reflect its nature as a breaking change rather than a fix.
Example:
### Changed
- [**breaking**] add serde derives for more types ([#112](https://github.com/grafana/augurs/pull/112))This would align better with the Keep a Changelog format and clearly indicate the breaking nature of the change.
github-actions
bot
force-pushed
the
release-plz-2024-10-10T06-42-10Z
branch
from
1cbfeff
to
cb4d595
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (5)
crates/augurs-seasons/CHANGELOG.md (2)
15-18: LGTM with a minor suggestion: "Other" section documents additional changeThe "Other" section appropriately documents the addition of the Prophet algorithm in the
augurs-prophetcrate, which is a relevant change to include in the changelog. The link to the related pull request is correctly included.Consider moving this item to the "Added" section, as it represents a new feature rather than a miscellaneous change. This would make the changelog more consistent and easier to read.
9-18: Overall, the changelog update is well-structured and informativeThe changes to the CHANGELOG.md file for
augurs-seasonsaccurately reflect the release of version 0.4.0. The new entry includes important information about the 'augurs' convenience crate and the addition of the Prophet algorithm. These updates align with the PR objectives and provide valuable context for users of the library.To further improve the changelog:
- Consider moving the Prophet algorithm addition to the "Added" section for better categorization.
- Ensure that all significant changes mentioned in the PR objectives (such as any breaking changes, if applicable to this crate) are included in the changelog.
crates/augurs-outlier/CHANGELOG.md (3)
15-18: Approved: Breaking changes well-documentedThe breaking changes are correctly marked and documented, which is crucial for users of the library. However, consider adding more details about the potential impact of these changes on existing code.
For example, you could expand on:
- Which types now have serde derives and how this might affect serialization/deserialization in existing code.
- How the optional
cluster_bandchanges the behavior when no cluster is found and what users need to do to handle this new case.
20-22: Consider relocating information about other cratesThe addition of the Prophet algorithm in the
augurs-prophetcrate is not directly related toaugurs-outlier. Consider moving this information to a more appropriate changelog, such as the one foraugurs-prophetor a general project changelog if one exists.This will help keep the changelog focused on changes specific to the
augurs-outliercrate.
9-22: Overall, the changelog entry is well-structured but could use minor improvementsThe changelog entry for version 0.4.0 effectively documents the key changes, including breaking changes and new features. However, consider the following improvements:
- Verify the release date (currently set in the future).
- Provide more details about the impact of the breaking changes.
- Move information about other crates (like
augurs-prophet) to their respective changelogs.- Consider adding a brief explanation of why these changes were made or how they benefit users.
These adjustments will enhance the clarity and usefulness of the changelog for your users.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (13)
- Cargo.toml (2 hunks)
- crates/augurs-changepoint/CHANGELOG.md (1 hunks)
- crates/augurs-clustering/CHANGELOG.md (1 hunks)
- crates/augurs-core/CHANGELOG.md (1 hunks)
- crates/augurs-dtw/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)
- crates/augurs-testing/CHANGELOG.md (1 hunks)
- crates/augurs/CHANGELOG.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
- crates/augurs-prophet/CHANGELOG.md
🚧 Files skipped from review as they are similar to previous changes (8)
- crates/augurs-changepoint/CHANGELOG.md
- crates/augurs-clustering/CHANGELOG.md
- crates/augurs-core/CHANGELOG.md
- crates/augurs-dtw/CHANGELOG.md
- crates/augurs-ets/CHANGELOG.md
- crates/augurs-forecaster/CHANGELOG.md
- crates/augurs-mstl/CHANGELOG.md
- crates/augurs-testing/CHANGELOG.md
🧰 Additional context used
🔇 Additional comments (9)
crates/augurs/CHANGELOG.md (3)
1-6: LGTM: Well-structured changelog headerThe changelog header is correctly formatted and includes references to Keep a Changelog and Semantic Versioning. This adheres to best practices for changelog maintenance.
8-8: LGTM: Appropriate "Unreleased" sectionThe inclusion of an empty "Unreleased" section is correct for a new release. This allows for easy tracking of future changes.
10-18: Review release date and consider recategorizing the Prophet algorithm addition
The release date (October 10, 2024) is set in the future. Please verify if this is intentional or if it should be adjusted to the current date.
Consider moving the Prophet algorithm addition from "Other" to "Added" as it represents a new feature. This would make the changelog more consistent and easier to read.
To confirm the intended release date, please run the following command:
Here's a suggested reorganization of the changelog entry:
## [0.4.0](https://github.com/grafana/augurs/compare/augurs-v0.3.1...augurs-v0.4.0) - 2024-10-10 ### Added - add 'augurs' convenience crate, re-exporting other crates ([#117](https://github.com/grafana/augurs/pull/117)) +- Add Prophet algorithm in `augurs-prophet` crate ([#118](https://github.com/grafana/augurs/pull/118)) - -### Other - -- Add Prophet algorithm in `augurs-prophet` crate ([#118](https://github.com/grafana/augurs/pull/118))crates/augurs-seasons/CHANGELOG.md (2)
9-10: LGTM: Version header correctly addedThe new version header for 0.4.0 is correctly formatted and includes the appropriate link to compare changes. The date is also consistent with the current timeframe.
11-14: LGTM: "Added" section correctly documents new featureThe "Added" section appropriately documents the introduction of the 'augurs' convenience crate, which aligns with the PR objectives. The link to the related pull request is correctly included.
crates/augurs-outlier/CHANGELOG.md (2)
9-10: Verify the release dateThe release date is set to 2024-10-10, which is in the future. Typically, changelogs use the current date or the date when the version was actually released.
Please confirm if this future date is intentional or if it should be updated to the current date.
11-13: LGTM: New convenience crate addedThe addition of the 'augurs' convenience crate that re-exports other crates is well-documented and aligns with the PR objectives.
Cargo.toml (2)
15-15: LGTM: Version bump to 0.4.0The workspace package version has been correctly updated to 0.4.0, which aligns with the release objectives stated in the PR summary.
The previous comment about the missing CHANGELOG.md file is still valid. Please ensure that a CHANGELOG.md file is added to document the changes introduced in version 0.4.0.
32-35: LGTM: Remaining dependencies updated consistentlyThe versions of
augurs-mstl,augurs-outlier,augurs-prophet, andaugurs-seasonshave been correctly updated to 0.4.0, maintaining consistency with the workspace package version and other dependency updates.
github-actions
bot
force-pushed
the
release-plz-2024-10-10T06-42-10Z
branch
from
cb4d595
to
8fd469f
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (4)
crates/augurs/CHANGELOG.md (1)
19-19: Minor: Consider consistent formatting for crate names.For consistency, consider formatting the crate name
augurs-prophetin backticks, similar to how it's formatted in other entries.Here's the suggested change:
- - Add Prophet algorithm in `augurs-prophet` crate ([#118](https://github.com/grafana/augurs/pull/118)) + - Add Prophet algorithm in `augurs-prophet` crate ([#118](https://github.com/grafana/augurs/pull/118))crates/augurs-outlier/CHANGELOG.md (3)
11-14: LGTM: Additions are well-documented.The "Added" section accurately reflects the new features mentioned in the PR objectives and AI-generated summary. The inclusion of pull request links is excellent for traceability.
Consider adding a brief explanation of the benefits or use cases for these new features to provide more context for users. For example:
- "Add cmdstan-based optimizer for augurs-prophet, improving performance for large datasets."
- "Add 'augurs' convenience crate, simplifying imports by re-exporting other crates."
16-19: Approved with suggestions: Breaking changes are correctly identified.The "Fixed" section correctly identifies two breaking changes, which aligns with the PR objectives. The use of the [breaking] tag is appropriate and helps users quickly identify potential compatibility issues.
To improve clarity and help users understand the impact of these changes, consider expanding the descriptions:
- For the serde derives: "Add serde derives for more types, enhancing serialization capabilities but potentially affecting existing serialization/deserialization code."
- For the
cluster_band: "Makecluster_bandoptional and undefined if no cluster is found, changing the behavior and return type of clustering functions."These expanded descriptions will help users better understand the implications of the breaking changes.
9-23: Overall, the changelog entry for version 0.4.0 is well-structured and informative.The changelog effectively communicates the major changes in this release, including new features, breaking changes, and other additions. The use of pull request links for each entry is excellent for traceability.
To further improve the changelog:
Consider adding a brief summary at the beginning of the 0.4.0 entry to highlight the most significant changes or the overall theme of this release. This can help users quickly grasp the importance of the update.
Maintain consistency in the level of detail provided for each entry. Some entries (like the Prophet algorithm addition) could benefit from more explanation, while others are adequately detailed.
For breaking changes, consider adding a "Migration" or "Upgrade Notes" section that provides guidance on how users can update their code to accommodate these changes.
These improvements will make the changelog even more valuable for users and maintainers of the project.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (13)
- Cargo.toml (2 hunks)
- crates/augurs-changepoint/CHANGELOG.md (1 hunks)
- crates/augurs-clustering/CHANGELOG.md (1 hunks)
- crates/augurs-core/CHANGELOG.md (1 hunks)
- crates/augurs-dtw/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)
- crates/augurs-testing/CHANGELOG.md (1 hunks)
- crates/augurs/CHANGELOG.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (11)
- Cargo.toml
- crates/augurs-changepoint/CHANGELOG.md
- crates/augurs-clustering/CHANGELOG.md
- crates/augurs-core/CHANGELOG.md
- crates/augurs-dtw/CHANGELOG.md
- crates/augurs-ets/CHANGELOG.md
- crates/augurs-forecaster/CHANGELOG.md
- crates/augurs-mstl/CHANGELOG.md
- crates/augurs-prophet/CHANGELOG.md
- crates/augurs-seasons/CHANGELOG.md
- crates/augurs-testing/CHANGELOG.md
🧰 Additional context used
🔇 Additional comments (5)
crates/augurs/CHANGELOG.md (3)
1-6: LGTM: Header and format declaration are well-structured.The changelog header and format declaration follow best practices, adhering to the "Keep a Changelog" format and Semantic Versioning principles. This structure will help maintain clear and consistent documentation of changes over time.
8-8: LGTM: "Unreleased" section is present and appropriately empty.The inclusion of an empty "Unreleased" section is good practice. It provides a place to document ongoing changes for the next release.
10-17: LGTM: Version 0.4.0 entry is well-structured and informative.The version 0.4.0 entry follows the expected format, including a helpful link to compare with the previous version. The categorization of changes into "Added" and "Other" sections provides clear information about the new features and improvements in this release.
crates/augurs-outlier/CHANGELOG.md (2)
9-10: LGTM: Version and date entry are correct.The version number (0.4.0) is consistent with the PR objectives, and the date format follows the ISO 8601 standard. The comparison link is correctly formatted, allowing users to view all changes since the previous version.
21-23: Suggestion: Provide more context for the Prophet algorithm addition.While the addition of the Prophet algorithm is noted, the entry could benefit from more detail to help users understand its significance.
Consider expanding this entry to provide more context:
"Add Prophet algorithm in
augurs-prophetcrate (#118), introducing advanced time series forecasting capabilities based on the Facebook Prophet model."This expanded description gives users a better understanding of what the Prophet algorithm is and its potential benefits.
To ensure the Prophet algorithm is properly integrated, you may want to run the following verification:
✅ Verification successful
Prophet Algorithm Integration Verified
The Prophet algorithm has been successfully integrated into the
augurs-prophetcrate.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the integration of the Prophet algorithm in the augurs-prophet crate # Test: Check for the presence of Prophet-related code in the augurs-prophet crate rg --type rust 'Prophet' crates/augurs-prophet/srcLength of output: 15854
crates/augurs/CHANGELOG.md
Outdated
| ## [0.4.0](https://github.com/grafana/augurs/compare/augurs-v0.3.1...augurs-v0.4.0) - 2024-10-10 | ||
|
|
||
| ### Added | ||
|
|
||
| - add cmdstan-based optimizer for augurs-prophet ([#121](https://github.com/grafana/augurs/pull/121)) | ||
| - add 'augurs' convenience crate, re-exporting other crates ([#117](https://github.com/grafana/augurs/pull/117)) | ||
|
|
||
| ### Other | ||
|
|
||
| - Add Prophet algorithm in `augurs-prophet` crate ([#118](https://github.com/grafana/augurs/pull/118)) |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider adding information about breaking changes.
The changelog effectively communicates the new features and improvements in version 0.4.0. However, based on the PR objectives, there are breaking changes in augurs-ets and augurs-outlier that are not mentioned in this changelog. Consider adding a "Breaking Changes" section to highlight these important changes.
Here's a suggested addition to the changelog:
## [0.4.0](https://github.com/grafana/augurs/compare/augurs-v0.3.1...augurs-v0.4.0) - 2024-10-10
+### Breaking Changes
+
+- `augurs-ets`: Removed or renamed some publicly-visible modules and constants.
+- `augurs-outlier`: Removed or renamed some public structs and fields.
+
### Added
- add cmdstan-based optimizer for augurs-prophet ([#121](https://github.com/grafana/augurs/pull/121))
- add 'augurs' convenience crate, re-exporting other crates ([#117](https://github.com/grafana/augurs/pull/117))
### Other
- Add Prophet algorithm in `augurs-prophet` crate ([#118](https://github.com/grafana/augurs/pull/118))This addition will ensure users are aware of potential breaking changes when upgrading to this version.
📝 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.
| ## [0.4.0](https://github.com/grafana/augurs/compare/augurs-v0.3.1...augurs-v0.4.0) - 2024-10-10 | |
| ### Added | |
| - add cmdstan-based optimizer for augurs-prophet ([#121](https://github.com/grafana/augurs/pull/121)) | |
| - add 'augurs' convenience crate, re-exporting other crates ([#117](https://github.com/grafana/augurs/pull/117)) | |
| ### Other | |
| - Add Prophet algorithm in `augurs-prophet` crate ([#118](https://github.com/grafana/augurs/pull/118)) | |
| ## [0.4.0](https://github.com/grafana/augurs/compare/augurs-v0.3.1...augurs-v0.4.0) - 2024-10-10 | |
| ### Breaking Changes | |
| - `augurs-ets`: Removed or renamed some publicly-visible modules and constants. | |
| - `augurs-outlier`: Removed or renamed some public structs and fields. | |
| ### Added | |
| - add cmdstan-based optimizer for augurs-prophet ([#121](https://github.com/grafana/augurs/pull/121)) | |
| - add 'augurs' convenience crate, re-exporting other crates ([#117](https://github.com/grafana/augurs/pull/117)) | |
| ### Other | |
| - Add Prophet algorithm in `augurs-prophet` crate ([#118](https://github.com/grafana/augurs/pull/118)) |
github-actions
bot
force-pushed
the
release-plz-2024-10-10T06-42-10Z
branch
from
8fd469f
to
3188079
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
Cargo.toml (1)
Line range hint
15-36: Reminder: Document breaking changesThe PR objectives mention breaking changes in
augurs-etsandaugurs-outlier. While these changes are not directly reflected in the Cargo.toml file, it's important to ensure they are properly documented in the respective crates' documentation and the project's CHANGELOG.md.Please ensure that:
- The breaking changes are clearly documented in the respective crates' documentation.
- The CHANGELOG.md file (once added) includes entries detailing these breaking changes.
- If applicable, consider adding deprecation notices or migration guides to help users update to the new version.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (13)
- Cargo.toml (2 hunks)
- crates/augurs-changepoint/CHANGELOG.md (1 hunks)
- crates/augurs-clustering/CHANGELOG.md (1 hunks)
- crates/augurs-core/CHANGELOG.md (1 hunks)
- crates/augurs-dtw/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)
- crates/augurs-testing/CHANGELOG.md (1 hunks)
- crates/augurs/CHANGELOG.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (12)
- crates/augurs-changepoint/CHANGELOG.md
- crates/augurs-clustering/CHANGELOG.md
- crates/augurs-core/CHANGELOG.md
- crates/augurs-dtw/CHANGELOG.md
- crates/augurs-ets/CHANGELOG.md
- crates/augurs-forecaster/CHANGELOG.md
- crates/augurs-mstl/CHANGELOG.md
- crates/augurs-outlier/CHANGELOG.md
- crates/augurs-prophet/CHANGELOG.md
- crates/augurs-seasons/CHANGELOG.md
- crates/augurs-testing/CHANGELOG.md
- crates/augurs/CHANGELOG.md
🧰 Additional context used
🔇 Additional comments (1)
Cargo.toml (1)
15-15: LGTM: Version bump to 0.4.0The workspace package version has been correctly updated to 0.4.0, which aligns with the release objectives stated in the PR summary.
The previous comment about the missing CHANGELOG.md file is still valid. Please ensure that a CHANGELOG.md file is added to the repository and that it documents the changes introduced in version 0.4.0.
github-actions
bot
force-pushed
the
release-plz-2024-10-10T06-42-10Z
branch
from
3188079
to
7041796
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (13)
- Cargo.toml (2 hunks)
- crates/augurs-changepoint/CHANGELOG.md (1 hunks)
- crates/augurs-clustering/CHANGELOG.md (1 hunks)
- crates/augurs-core/CHANGELOG.md (1 hunks)
- crates/augurs-dtw/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)
- crates/augurs-testing/CHANGELOG.md (1 hunks)
- crates/augurs/CHANGELOG.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (12)
- crates/augurs-changepoint/CHANGELOG.md
- crates/augurs-clustering/CHANGELOG.md
- crates/augurs-core/CHANGELOG.md
- crates/augurs-dtw/CHANGELOG.md
- crates/augurs-ets/CHANGELOG.md
- crates/augurs-forecaster/CHANGELOG.md
- crates/augurs-mstl/CHANGELOG.md
- crates/augurs-outlier/CHANGELOG.md
- crates/augurs-prophet/CHANGELOG.md
- crates/augurs-seasons/CHANGELOG.md
- crates/augurs-testing/CHANGELOG.md
- crates/augurs/CHANGELOG.md
🧰 Additional context used
🔇 Additional comments (1)
Cargo.toml (1)
32-35: LGTM: Remaining dependencies updated consistentlyThe versions for
augurs-mstl,augurs-outlier,augurs-prophet, andaugurs-seasonshave been correctly updated to 0.4.0, maintaining consistency with the workspace package version and other dependency updates.
| @@ -12,7 +12,7 @@ authors = [ | |||
| ] | |||
| documentation = "https://docs.rs/crate/augurs" | |||
| repository = "https://github.com/grafana/augurs" | |||
| version = "0.3.1" | |||
| version = "0.4.0" | |||
There was a problem hiding this comment.
Version bump to 0.4.0 approved, but CHANGELOG.md is missing
The workspace package version has been correctly updated to 0.4.0, which aligns with the release objectives stated in the PR summary. However, the repository still lacks a CHANGELOG.md file.
Please add a CHANGELOG.md file to the repository root and document the changes introduced in version 0.4.0. This will help users and contributors understand the evolution of the project.
github-actions
bot
force-pushed
the
release-plz-2024-10-10T06-42-10Z
branch
4 times, most recently
from
3990da3
to
29f88d3
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (13)
- Cargo.toml (2 hunks)
- crates/augurs-changepoint/CHANGELOG.md (1 hunks)
- crates/augurs-clustering/CHANGELOG.md (1 hunks)
- crates/augurs-core/CHANGELOG.md (1 hunks)
- crates/augurs-dtw/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)
- crates/augurs-testing/CHANGELOG.md (1 hunks)
- crates/augurs/CHANGELOG.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (12)
- crates/augurs-changepoint/CHANGELOG.md
- crates/augurs-clustering/CHANGELOG.md
- crates/augurs-core/CHANGELOG.md
- crates/augurs-dtw/CHANGELOG.md
- crates/augurs-ets/CHANGELOG.md
- crates/augurs-forecaster/CHANGELOG.md
- crates/augurs-mstl/CHANGELOG.md
- crates/augurs-outlier/CHANGELOG.md
- crates/augurs-prophet/CHANGELOG.md
- crates/augurs-seasons/CHANGELOG.md
- crates/augurs-testing/CHANGELOG.md
- crates/augurs/CHANGELOG.md
🧰 Additional context used
🔇 Additional comments (2)
Cargo.toml (2)
15-15: Version 0.4.0 update approved, but CHANGELOG.md is still missingThe workspace package version has been correctly updated to 0.4.0, which aligns with the release objectives stated in the PR summary. However, the repository still lacks a
CHANGELOG.mdfile.Please add a
CHANGELOG.mdfile to the repository root and document the changes introduced in version0.4.0. This will help users and contributors understand the evolution of the project.
Line range hint
38-71: Verify if other dependencies require updatesWhile the main Augurs dependencies have been updated, the versions of other dependencies (e.g.,
anyhow,chrono,serde, etc.) remain unchanged.Please verify if any of these dependencies require updates to ensure compatibility with the new version of Augurs. You can use the following script to check for outdated dependencies:
This will help ensure that all dependencies are up-to-date and compatible with the new version.
| augurs = { version = "0.4.0", path = "crates/augurs" } | ||
| augurs-changepoint = { version = "0.4.0", path = "crates/augurs-changepoint" } | ||
| augurs-clustering = { version = "0.4.0", path = "crates/augurs-clustering" } | ||
| augurs-core = { version = "0.4.0", path = "crates/augurs-core" } | ||
| augurs-dtw = { version = "0.4.0", path = "crates/augurs-dtw" } | ||
| augurs-ets = { version = "0.4.0", path = "crates/augurs-ets" } |
There was a problem hiding this comment.
Dependency versions updated, but some inconsistencies remain
The dependency versions have been correctly updated to 0.4.0 for most packages, maintaining consistency with the workspace package version. This aligns with the release objectives. However, there are still two inconsistencies:
augurs-forecaster(line 31) is not updated to version 0.4.0augurs-testing(line 36) is not updated to version 0.4.0
Please update the versions for augurs-forecaster and augurs-testing to 0.4.0 to ensure consistency across all dependencies. This will help prevent potential compatibility issues within the project.
Also applies to: 32-35
github-actions
bot
force-pushed
the
release-plz-2024-10-10T06-42-10Z
branch
from
29f88d3
to
d4449c6
Compare
github-actions
bot
force-pushed
the
release-plz-2024-10-10T06-42-10Z
branch
from
d4449c6
to
7d09534
Compare
🤖 New release
augurs: 0.3.1 -> 0.4.0augurs-changepoint: 0.3.1 -> 0.4.0 (✓ API compatible changes)augurs-core: 0.3.1 -> 0.4.0 (✓ API compatible changes)augurs-testing: 0.3.1 -> 0.4.0 (✓ API compatible changes)augurs-clustering: 0.3.1 -> 0.4.0augurs-dtw: 0.3.1 -> 0.4.0augurs-ets: 0.3.1 -> 0.4.0 (augurs-mstl: 0.3.1 -> 0.4.0 (✓ API compatible changes)augurs-forecaster: 0.3.1 -> 0.4.0 (✓ API compatible changes)augurs-outlier: 0.3.1 -> 0.4.0 (augurs-prophet: 0.3.1 -> 0.4.0augurs-seasons: 0.3.1 -> 0.4.0 (✓ API compatible changes)augurs-etsbreaking changesaugurs-outlierbreaking changesChangelog
augursaugurs-changepointaugurs-coreaugurs-testingaugurs-clusteringaugurs-dtwaugurs-etsaugurs-mstlaugurs-forecasteraugurs-outlieraugurs-prophetaugurs-seasonsThis PR was generated with release-plz.
Summary by CodeRabbit
Release Notes
New Features
augurs-prophetcrate.augurs-prophetcrate.Bug Fixes
augurs-forecasterproject.serdederives for more types.