chore: sealed_currencies v2.1.0
#297
Conversation
π WalkthroughWalkthroughThis pull request updates the GitHub Actions workflow by moving the Dart setup step to follow the workspace cleaning step, both controlled by the same condition. It also removes the memory tools file and the associated dependency from the sealed world tests package. In the sealed currencies package, the changelog is updated to reflect a new version and a modified method signature, the README now presents test coverage in a metric format, documentation comments in currency-related classes have been reformatted, and package version along with a dependency has been updated. Changes
Sequence Diagram(s)sequenceDiagram
participant Runner as GitHub Actions Runner
participant Checkout as Git Checkout
participant Cleaner as Workspace Cleaner
participant DartSetup as Dart Setup
Runner->>Checkout: Checkout repository
Checkout->>Cleaner: Trigger workspace cleaning (if is_flutter)
Cleaner->>DartSetup: Proceed with Dart setup (if is_flutter)
Suggested labels
Suggested reviewers
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 (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
π Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
π Files selected for processing (8)
.github/workflows/verify_package_workflow.yaml(1 hunks)packages/_sealed_world_tests/lib/tools/memory_tools.dart(0 hunks)packages/_sealed_world_tests/pubspec.yaml(0 hunks)packages/sealed_currencies/CHANGELOG.md(2 hunks)packages/sealed_currencies/README.md(1 hunks)packages/sealed_currencies/lib/src/model/currency/currency.dart(2 hunks)packages/sealed_currencies/lib/src/model/currency/submodels/crypto_currency.dart(2 hunks)packages/sealed_currencies/pubspec.yaml(2 hunks)
π€ Files with no reviewable changes (2)
- packages/_sealed_world_tests/pubspec.yaml
- packages/_sealed_world_tests/lib/tools/memory_tools.dart
π§° Additional context used
π Learnings (1)
packages/sealed_currencies/pubspec.yaml (1)
Learnt from: tsinis
PR: tsinis/sealed_world#237
File: packages/sealed_countries/pubspec.yaml:24-24
Timestamp: 2024-11-12T12:26:43.241Z
Learning: `sealed_currencies` version 1.5.1 does not introduce any breaking changes.
πͺ markdownlint-cli2 (0.17.2)
packages/sealed_currencies/CHANGELOG.md
1-1: First line in a file should be a top-level heading
null
(MD041, first-line-heading, first-line-h1)
β° Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Verify sealed_currencies / β³ Verify sealed_currencies Package
π Additional comments (7)
packages/sealed_currencies/lib/src/model/currency/submodels/crypto_currency.dart (1)
10-15: Documentation improvements look good!The changes enhance clarity by:
- Using consistent Markdown-style parameter references
- Explicitly documenting optional parameters and their default values
- Maintaining consistency with the parent
Currencyclass documentation styleAlso applies to: 47-48
packages/sealed_currencies/lib/src/model/currency/currency.dart (1)
16-22: Documentation improvements look good!The changes enhance clarity by:
- Using consistent Markdown-style parameter references
- Maintaining consistent documentation style across the codebase
- Improving readability of parameter references in class and method documentation
Also applies to: 28-29, 33-37, 73-74
packages/sealed_currencies/pubspec.yaml (2)
1-1: Version Update Confirmation
The package version has been bumped to 2.1.0. Please ensure all related documentation and tooling reflect this update.
29-29: Dependency Update Verification
The dependency for sealed_languages has been updated to ^2.1.0. Confirm that this upgrade is fully compatible with your codebase and does not introduce any breaking changes..github/workflows/verify_package_workflow.yaml (1)
38-43: Reordering of Dart Setup Step
The Dart setup step has been moved right after the workspace cleaner step. This reordering ensures that any workspace modifications are applied before the Dart SDK is set up. Please verify that this change preserves the intended behavior of the workflow.packages/sealed_currencies/CHANGELOG.md (2)
1-6: Changelog Update and Refactor Details
The changelog now begins with β## 2.1.0β and summarizes the refactoring of methods such as maybeCommonNameFor along with updating deprecation notices. Ensure that the instructions provided here match the accompanying migration guides and documentation.π§° Tools
πͺ markdownlint-cli2 (0.17.2)
1-1: First line in a file should be a top-level heading
null(MD041, first-line-heading, first-line-h1)
36-36: Deprecation Notice Clarity
The deprecation note for the sealed_currency_translations library is clear. Please double-check that the migration path to using the l10n_currencies package (or the l10n getter) is thoroughly documented for users.
Codecov ReportAll modified and coverable lines are covered by tests β
Additional details and impacted files@@ Coverage Diff @@
## main #297 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 30 7 -23
Lines 482 160 -322
==========================================
- Hits 482 160 -322
Flags with carried forward coverage won't be shown. Click here to find out more. β View full report in Codecov by Sentry. |
Description
Type of Change
Checks
Please look at the following checklist to ensure that your PR can be accepted quickly:
Summary by CodeRabbit
New Features
β’ Enhanced currency naming now robustly handles missing locale data for seamless integration.
β’ Upgraded package to version 2.1.0.
Documentation
β’ Improved API docs for currency and crypto features.
β’ Revised test coverage details for clarity.
Chores
β’ Streamlined internal processes with refined dependency management, removal of legacy memory tracking utilities, and optimized testing workflows.