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

Codespaces for Tutorials #601

Merged
merged 1 commit into from
May 20, 2024

Conversation

jcarnaxide
Copy link
Contributor

Describe your changes
I am adding the ability to spawn a preconfigured codespace for this repo specifically designed for executing the tutorials. This will allow for tutorial ease of use, and required less initial setup by users to run the exercises.

Testing performed
I built the documentation with the modifications and they changes all rendered fine. I also spawned the corresponding codespace and the exercises all work as expected.

Additional context
One thing to note, is I am not exactly sure how the link provided via the rendered button will work, only because I am pointing to the main branch for the bloomberg/memray repo, which currently does NOT have a devcontainer.json configured. But once, we do, that button should take the user to a screen to configure a corresponding codespace.

Docs for Codespaces
You can get an idea what that screen would look like by clicking the following link, pointing to my local branch.
https://codespaces.new/jcarnaxide/memray/tree/codespaces-for-tutorials

@jcarnaxide
Copy link
Contributor Author

@godlygeek I have some additional instructions on how to run the tutorial using github codespaces.
If you have time to take a look, and want to include these updates for your sprinting tomorrow, feel free to have a look.

We would also greatly appreciate having this setup for our run through in Pycon Italia this week as well!

@statkute F.Y.I.

@codecov-commenter
Copy link

codecov-commenter commented May 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.84%. Comparing base (41248ed) to head (3f9166f).
Report is 52 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #601      +/-   ##
==========================================
+ Coverage   92.55%   92.84%   +0.29%     
==========================================
  Files          91       92       +1     
  Lines       11304    11234      -70     
  Branches     1581     2055     +474     
==========================================
- Hits        10462    10430      -32     
+ Misses        837      804      -33     
+ Partials        5        0       -5     
Flag Coverage Δ
cpp 92.84% <ø> (+6.90%) ⬆️
python_and_cython 92.84% <ø> (-2.88%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jcarnaxide jcarnaxide force-pushed the codespaces-for-tutorials branch 2 times, most recently from 335caf1 to 0bce715 Compare May 20, 2024 13:50

.. raw:: html

<a href='https://codespaces.new/bloomberg/memray?devcontainer_path=.devcontainer%2Ftutorials%2Fdevcontainer.json'><img src='https://github.com/codespaces/badge.svg' alt='Open in GitHub Codespaces' style='max-width: 100%;'></a>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is how we have the github UI load with the correct codespace preselected. This won't work until merged in since it is pointing to the main repo/branch of Memray, but for a sample you can refer to my branch via this link:

https://codespaces.new/jcarnaxide/memray/tree/codespaces-for-tutorials?devcontainer_path=.devcontainer%2Ftutorials%2Fdevcontainer.json

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Snag_30c72e

@godlygeek godlygeek force-pushed the codespaces-for-tutorials branch 2 times, most recently from 2a1a7f3 to 6ec8279 Compare May 20, 2024 20:19
Update the tutorials documentation to suggest the Codespaces approach.

Signed-off-by: Jesse Carnaxide <jcarnaxide@gmail.com>
Copy link
Contributor

@godlygeek godlygeek left a comment

Choose a reason for hiding this comment

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

Looks great - thanks!

@godlygeek godlygeek enabled auto-merge (rebase) May 20, 2024 20:23
@godlygeek godlygeek merged commit adda8e7 into bloomberg:main May 20, 2024
17 checks passed
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.

3 participants