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

Feature/gitpod #64

Merged
merged 22 commits into from
Jul 28, 2022
Merged

Feature/gitpod #64

merged 22 commits into from
Jul 28, 2022

Conversation

SergioGasquez
Copy link
Member

@SergioGasquez SergioGasquez commented May 5, 2022

Include support for online workspaces with Gitpod

Closes #61

@justahero
Copy link
Contributor

Hello @SergioGasquez ,

first of all thank you for adding gitpod support. I tested the new gitpod link in the Readme, it was quite a neat experience to either have the VS Code editor open via web or connecting the desktop editor to the gitpod workspace remotely. 👍

As this is a new setup (I have not much experience with) we would like to add brief instructions to the book, could you help me with the following questions?

  • can this environment be used to flash a embedded device locally?
  • if yes could you give the instructions on how to achieve that when they differ from the instructions in the training book?
  • if not, is the gitpod environment meant to be used only in combination with the wowki simulator?
  • are there any necessary requirements or steps the user needs to be aware of (e.g. requires Github account) or that you recommend?

Thanks so much, this helps us to ensure we provide the right instructions for users.

&& .espressif/frameworks/esp-idf-v4.4/install.sh ${ESP_BOARD} \
&& rm -rf .espressif/dist \
&& rm -rf .espressif/frameworks/esp-idf-v4.4/docs
&& rm -rf .espressif/frameworks/esp-idf-v4.4/docs \
&& rm -rf .espressif/frameworks/esp-idf-v4.4/examples \
Copy link
Contributor

Choose a reason for hiding this comment

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

Cleaning even more unnecessary folders is good 👍

Copy link
Member Author

Choose a reason for hiding this comment

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

Hello! Thanks for your feedback! I will be addressing the other comments soon. Those changes on the Dockerfile are in another PR: #69, maybe we should first merge those changes since it reduces build time (by properly activating esp-idf environment) and the Dockerfile is more polished!

@@ -17,7 +17,7 @@ default = ["native"]
native = ["esp-idf-sys/native"]

[dependencies]
esp-idf-sys = { version = "0.30", features = ["binstart"] }
esp-idf-sys = { version = "=0.31.5", features = ["binstart"] }
Copy link
Contributor

Choose a reason for hiding this comment

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

There are few version bumps that update esp related dependencies. Would you mind putting that into a separate Pull Request? If that is a required change to make the gitpod environment work, please add a comment.

Once PR #66 is in main, we can use the CI pipeline to ensure no breaking change is introduced when updating dependencies.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, those are addressed in a different PR. Sorry, maybe I should have closed this PR until #69 gets merged to avoid confussion.

@SergioGasquez
Copy link
Member Author

  • can this environment be used to flash a embedded device locally?
  • if yes could you give the instructions on how to achieve that when they differ from the instructions in the training book?
  • if not, is the gitpod environment meant to be used only in combination with the wowki simulator?

No, at the moment we don't know any way of flashing from gitpod, although we are working on it. That being said, since you can download the resulting binaries, there are two alternative methods:

Gitpod can be used to simulate all the projects with Wokwi (I will create the PR once we address the 2 currently opened), but it can also be used to compile all the projects without having to install anything on the host machine.

  • are there any necessary requirements or steps the user needs to be aware of (e.g. requires Github account) or that you recommend?

Gitpod only requires an account which can be created with a GitLab, GitHub or Bitbucket account.

@justahero
Copy link
Contributor

Thanks a lot for the notes on gitpod, that will help a lot when adding instructions to the book. 👍

@SergioGasquez SergioGasquez marked this pull request as draft June 2, 2022 17:36
@SergioGasquez
Copy link
Member Author

SergioGasquez commented Jul 19, 2022

Hello @justahero ! Following todays merges, I've merged changes from main branch and run the test.sh script successfully from gitpod, so all the projects are building fine!

@SergioGasquez SergioGasquez marked this pull request as ready for review July 19, 2022 16:13
source /home/gitpod/.espressif/frameworks/esp-idf-v4.4/export.sh > /dev/null 2>&1
vscode:
extensions:
- matklad.rust-analyzer
Copy link
Contributor

Choose a reason for hiding this comment

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

A few weeks ago (after this PR was opened) the rust-analyzer project moved into the official Rust GH account. It's now available under the identifier rust-lang.rust-analyzer.

Copy link
Member Author

Choose a reason for hiding this comment

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

Gitpod uses the Open VSX registry, where rust-analyzer is still under matklad.rust-analyzer, I will try to keep an eye on it in case it gets updated!

Copy link
Contributor

Choose a reason for hiding this comment

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

Good to know.

Copy link
Contributor

@justahero justahero left a comment

Choose a reason for hiding this comment

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

LGTM

@justahero justahero merged commit 429f5bd into esp-rs:main Jul 28, 2022
@SergioGasquez SergioGasquez deleted the feature/gitpod branch July 28, 2022 08:47
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.

Add support for Gitpod devcontainers
2 participants