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.

Sign up for GitHub

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

Jump to bottom

Document how to update conda-lock.yml file in the main README.md #29

Merged
merged 2 commits into from
Dec 4, 2022
Merged

Document how to update conda-lock.yml file in the main README.md #29

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40f0b12
Document how to update conda-lock.yml file in the main README.md
weiji14 Dec 2, 2022
45e1622
Add links to directly edit environment.yml or apt.txt in GitHub UI
weiji14 Dec 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,22 @@
The JupyterHub docker image used for [hub.cryointhecloud.com](https://cryointhecloud.com),
hosted on https://quay.io/repository/cryointhecloud/cryo-hub-image

## Adding packages to this repository
## Updating packages in this repository

You can easily add more packages to the cryointhecloud hub by making pull requests to this
repository. Edit either the `environment.yml` file (for most packages) or `apt.txt` file
(for packages that need to be used in the Linux Desktop environment in the cloud), and make
a pull request - you can even do that just from the GitHub UI! A bot will comment with a link to
[mybinder.org](https://mybinder.org) where you can test your pull request to make sure it works
as you would expect.
You can add or update packages on the cryointhecloud hub by making pull requests to this
repository. Follow these steps:

1. Edit either the [`environment.yml`](https://github.com/CryoInTheCloud/hub-image/edit/main/environment.yml)
file (for most packages) or [`apt.txt`](https://github.com/CryoInTheCloud/hub-image/edit/main/apt.txt)
file (for packages that need to be used in the Linux Desktop environment in the cloud).
2. Start a [pull request](https://github.com/CryoInTheCloud/hub-image/pulls) -
you can even do that just from the GitHub UI! A bot will comment with a link to
[mybinder.org](https://mybinder.org) where you can test your pull request to make sure it works
as you would expect.
3. In the Pull Request, write a comment with the slash command `/condalock`.
This will refresh the [`conda-lock.yml`](https://conda-incubator.github.io/conda-lock/output/#unified-lockfile)
file that contains a snapshot of the exact library versions contained in the
conda environment, which will be useful for reproducibility.

Once your PR gets merged, you can follow the [2i2c docs](https://docs.2i2c.org/en/latest/admin/howto/configurator.html)
to have the hub use them!