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

Docs on updating pins #14

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Docs on updating pins #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 23 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,32 @@ on the binder.pangeo.io binder with the ``2020.10.10`` version of this image.

https://binder.pangeo.io/v2/gh/pangeo-gallery/default-binder/2020.10.10/?urlpath=git-pull?repo=https://github.com/pangeo-gallery/example-gallery%26amp%3Burlpath=lab/tree/example-gallery

## Releasing
## Pinning

We strongly recommend using a specific tagged version of the images here,
rather than just pointing to ``master``.
https://github.com/pangeo-gallery/default-binder/tags has a list of the tags.
This ensures that updates to the image don't unexpectedly break your notebooks.

## Updating versions

Suppose you've made an update to your gallery content that relies on a feature from
a new package or an updated version of the package.

If `pangeo-gallery/default-binder` already has a [tag](https://github.com/pangeo-gallery/default-binder/tags)
with the versions you need, you can just update the `binder_ref` value in your `binder-gallery.yaml`. For
example, change `binder_ref: 2020.10.10` to `binder_ref: 2020.10.27` in https://github.com/rsignell-usgs/esip-gallery/blob/aaef02335bbea0cf3ddaccf82f482a0e0af11339/binder-gallery.yaml#L8.

If there isn't a tag available yet, you can ask the pangeo-gallery maintainers to make one.
There may be a pull request from Dependabot updating the image, or we can manually trigger
an update from https://github.com/pangeo-gallery/default-binder/network/updates. To make a
release, a maintainer will push a tag.

```
git checkout master
git pull
git tag -a <date-of-image> -m "<date-of-image>"
git push upstream master --follow-tags
```

And now you can update your `binder_ref` as described above.