search

espressif / idf-eclipse-plugin

Espressif-IDE (based on Eclipse CDT) for ESP-IDF CMake based projects 4.x and above
Eclipse Public License 2.0
295 stars 115 forks source link

IEP-1153: Configure GitHub and PyWheels mirrors #888

Closed alirana01 closed 4 months ago

alirana01 commented 5 months ago

Description

Added a setting to configure the mirrors for tools installation in the Espressif Preference page to help users configure the installation of the tools via a different mirrors

Fixes # (IEP-1153)

Type of change

Please delete options that are not relevant.

How has this been tested?

Configure the mirror for the Github and python pip wheels to the cn server and install tools make sure to clear up the pip caches on your system and the espressif home directory. Install tools observe that the console should be downloading the tools from the defined mirror

image

Test Configuration:

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 5 months ago

Walkthrough

The project has updated preferences related to the Espressif Internet Development Framework (IDF), focusing on managing external assets and Python package installations. New constants for GitHub assets and a Python package index URL have been introduced. The UI preferences page now accommodates these settings with new fields and preference handling. The tools handler has been enhanced to consider these preferences during command execution.

Changes

Files Change Summary
.../IDFCorePreferenceConstants.java
.../EspresssifPreferencesPage.java
.../Messages.java
.../messages.properties		 Added new constants IDF_GITHUB_ASSETS, IDF_GITHUB_ASSETS_DEFAULT, PIP_EXTRA_INDEX_URL, and PIP_EXTRA_INDEX_URL_DEFAULT to IDFCorePreferenceConstants. Updated EspresssifPreferencesPage.java to include tools installation settings for GitHub assets and Python wheels. Added new strings and labels related to tools installation preferences.
.../AbstractToolsHandler.java Updated functionality to retrieve preferences for IDF GitHub assets and PIP extra index URL to set environment variables during command execution.
FAQ.md Added information about setting mirrors for Git and Pip Py Wheels in Eclipse Preferences to resolve timeout errors during tool installation. Instructions provided for adjusting mirrors based on region.

Poem

šŸŒŸ In the realm of code, where the bits entwine, šŸ‡ CodeRabbit hopped through the commit line. šŸ› ļø Tools and prefs, in harmony they dance, šŸŽ‰ A change so neat, it deserves a glance.

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
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 .` - `Generate unit-tests for this file.` - 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 tests 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 from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@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. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
kolipakakondal commented 5 months ago

@alirana01 Please rebase the changes with the master to resolve the conflcits so that @AndriiFilippov could verify further.

AndriiFilippov commented 4 months ago

@alirana01 hi!

Tested under:

OS - Windows 10 ESP-IDF: v5.1.2

during tool installation: image

AndriiFilippov commented 4 months ago

@alirana01 hi !

Tested under: OS - Windows 10 ESP-IDF: v5.1.2

able to install tools / pip using cn mirrors šŸŸ¢ able to build / flash / debug / monitor šŸŸ¢ do see usage of particular links: image

LGTM šŸ‘