Skip to content

Remove nanoFramework.System.Runtime dependency #259

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

Merged
merged 5 commits into from
Jun 12, 2024

Conversation

CoryCharlton
Copy link
Member

@CoryCharlton CoryCharlton commented May 24, 2024

Description

Remove nanoFramework.System.Runtime dependency

Motivation and Context

Resolves new runtime dependency

How Has This Been Tested?

  • Manually

Screenshots

Types of changes

  • Improvement (non-breaking change that improves a feature, code or algorithm)
  • Bug fix (non-breaking change which fixes an issue with code or algorithm)
  • New feature (non-breaking change which adds functionality to code)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Config and build (change in the configuration and build system, has no impact on code or features)
  • Dependencies (update dependencies and changes associated, has no impact on code or features)
  • Unit Tests (add new Unit Test(s) or improved existing one(s), has no impact on code or features)
  • Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist:

  • My code follows the code style of this project (only if there are changes in source code).
  • My changes require an update to the documentation (there are changes that require the docs website to be updated).
  • I have updated the documentation accordingly (the changes require an update on the docs in this repo).
  • I have read the CONTRIBUTING document.
  • I have tested everything locally and all new and existing tests passed (only if there are changes in source code).
  • I have added new tests to cover my changes.

Summary by CodeRabbit

  • Chores
    • Removed outdated dependency on nanoFramework.System.Runtime version 1.0.27 to streamline the package management.

Copy link

coderabbitai bot commented May 24, 2024

Walkthrough

The recent update to the TestFramework involves removing the dependency on nanoFramework.System.Runtime version 1.0.27 from the packages.lock.json file. This change simplifies the dependency management for the project by eliminating an unnecessary package.

Changes

File Path Change Summary
source/TestFramework/packages.lock.json Removed dependency on nanoFramework.System.Runtime version 1.0.27

Sequence Diagram(s)

No sequence diagrams are necessary for this change as it solely involves the removal of a package dependency without altering the control flow or introducing new features.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@CoryCharlton CoryCharlton changed the title Add nanoFramework.System.Runtime to nuspec dependencies Remove nanoFramework.System.Runtime dependency May 24, 2024
Copy link

@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

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 60ea171 and 9854283.
Files ignored due to path filters (7)
  • poc/TestOfTestFrameworkByReference/NFUnitTestByReference.nfproj is excluded by none and included by none
  • poc/TestOfTestFrameworkByReference/Test.cs is excluded by none and included by none
  • poc/TestOfTestFrameworkByReference/packages.config is excluded by none and included by none
  • source/TestFramework/CallerArgumentExpressionAttribute.cs is excluded by none and included by none
  • source/TestFramework/NullableAttributes.cs is excluded by none and included by none
  • source/TestFramework/nanoFramework.TestFramework.nfproj is excluded by none and included by none
  • source/TestFramework/packages.config is excluded by none and included by none
Files selected for processing (1)
  • source/TestFramework/packages.lock.json (1 hunks)
Files skipped from review due to trivial changes (1)
  • source/TestFramework/packages.lock.json

@jazzman55
Copy link

I believe this would fix the recent error on tests on our CI:

Link failure: some assembly references cannot be resolved!!
Assembly: NFUnitTest (0.0.0.0) needs assembly 'nanoFramework.TestFramework' (2.1.104.0)
Assembly: nanoFramework.TestFramework (2.1.104.0) needs assembly 'nanoFramework.System.Runtime' (1.0.27.0)
Assembly: nanoFramework.UnitTestLauncher (0.0.0.0) needs assembly 'nanoFramework.TestFramework' (2.1.104.0)
Error: a3000000

@CoryCharlton
Copy link
Member Author

I believe this would fix the recent error on tests on our CI:

Link failure: some assembly references cannot be resolved!! Assembly: NFUnitTest (0.0.0.0) needs assembly 'nanoFramework.TestFramework' (2.1.104.0) Assembly: nanoFramework.TestFramework (2.1.104.0) needs assembly 'nanoFramework.System.Runtime' (1.0.27.0) Assembly: nanoFramework.UnitTestLauncher (0.0.0.0) needs assembly 'nanoFramework.TestFramework' (2.1.104.0) Error: a3000000

This change will definitely fix that error. In the meantime you can downgrade the TestFramework nuget reference OR directly reference nanoFramework.System.Runtime in your test projects.

@jazzman55
Copy link

@josesimoes :)

@josesimoes
Copy link
Member

@josesimoes :)

Yes? 😁 If you're asking for this to be merged (and trust me, I understand the need to get this fixes asap) it still needs to be validated against mscorlib tests. The latest changes bring nice improvements, agreed. Still we need to make sure that the test framework doesn't get broken or that we lose fundamental features (such as being able to run/update tests in mscorlib) because of those.

@jazzman55
Copy link

@josesimoes , TestFramework is actually broken right now and this PR fixes that :)
Reference to nanoFramework.System.Runtime was added to the project, but not to the nuspec (so nuget doesn't install it as dependency). AS result, after upgrading to the latest version TestFramework breaks our CI builds and no tests are executing. I understand it needs to be tested, just bringing your attention ;)

@CoryCharlton
Copy link
Member Author

CoryCharlton commented May 29, 2024

@josesimoes , TestFramework is actually broken right now and this PR fixes that :) Reference to nanoFramework.System.Runtime was added to the project, but not to the nuspec (so nuget doesn't install it as dependency). AS result, after upgrading to the latest version TestFramework breaks our CI builds and no tests are executing. I understand it needs to be tested, just bringing your attention ;)

@jazzman55 For reference there is an open discussion regarding this in Discord: https://discord.com/channels/478725473862549535/1243509599223418933

Copy link
Member

@josesimoes josesimoes left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9854283 and 84ecbf1.

Files ignored due to path filters (3)
  • .github/workflows/update-dependencies.yml is excluded by none and included by none
  • source/TestFramework/nanoFramework.TestFramework.nfproj is excluded by none and included by none
  • source/TestFramework/packages.config is excluded by none and included by none
Files selected for processing (1)
  • source/TestFramework/packages.lock.json (1 hunks)
Files skipped from review due to trivial changes (1)
  • source/TestFramework/packages.lock.json

@josesimoes josesimoes enabled auto-merge (squash) June 12, 2024 08:22
@josesimoes josesimoes merged commit fb7f57a into nanoframework:main Jun 12, 2024
4 checks passed
@CoryCharlton CoryCharlton deleted the update_nuspec branch June 12, 2024 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants