Navigation Menu

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

[MRG] add hydroshare as a repo provider #967

Merged
merged 14 commits into from Feb 3, 2020

Conversation

sblack-usu
Copy link
Contributor

repo2docker changes:
jupyterhub/repo2docker#800

Copy link
Contributor

@nuest nuest left a comment

Choose a reason for hiding this comment

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

LGTM, just wondering about the wording to be consistent with other DOI-based repos.

@@ -56,6 +56,7 @@ <h4 id="form-header" class='row'>Build and launch a repository</h4>
<li class="dropdown-item" value="git"><a href="#">Git repository</a></li>
<li class="dropdown-item" value="zenodo"><a href="#">Zenodo DOI</a></li>
<li class="dropdown-item" value="figshare"><a href="#">Figshare DOI</a></li>
<li class="dropdown-item" value="hydroshare"><a href="#">Hydroshare resource</a></li>
Copy link
Contributor

Choose a reason for hiding this comment

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

I am unsure about the wording here, because for Zenodo and Fishare, we also support plain Zenodo URLs (they are just patched through), and it seems the Hydroshare support in repo2docker also supports DOIs...

@betatim What wording should BinderHub use here? Favour "DOI" or "resource" (or "record"). I'd tend towards only talking about DOIs externally, but not failing when direct resource URLs are provided.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I used resource because it is a HydroShare term. I'm fine highlighting the DOI, but I do think it'd be good to point to a resource id as well, because resources don't have a functional DOI until they publish the resource. Let me know what you'd like, and I can update it in this PR

Copy link
Member

Choose a reason for hiding this comment

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

I think if there's a provider-specific wording, we can just use that since a user familiar with it will be expecting that word (as long as it's not too long or complex)

binderhub/tests/test_repoproviders.py Show resolved Hide resolved
@sblack-usu sblack-usu closed this Oct 16, 2019
@sblack-usu sblack-usu reopened this Oct 16, 2019
@sblack-usu sblack-usu changed the title [wip] add hydroshare as a repo provider [MRG] add hydroshare as a repo provider Oct 16, 2019
@sblack-usu
Copy link
Contributor Author

@nuest @betatim - Anything else you need from me to get this merged? The only thing I'm aware that is up for question here is what the HydroShare DOI/Resource box label should say. I'm happy to use what you'd like.

@jhamman
Copy link

jhamman commented Dec 2, 2019

pinging @betatim and @choldgraf. Anything left to do here before merging?

@choldgraf
Copy link
Member

I can try to take a pass at this something this week. I'm a bit unsure of the details for hydroshare's API etc, so I'll have to take y'alls word on this. @nuest do you think this one is good to go?

@choldgraf
Copy link
Member

This looks good to me - I'd like to get

#1017

merged, and then have this PR add some documentation about the HydroShare provider, before merging. Sounds good?

@sblack-usu
Copy link
Contributor Author

I'll be happy to update documentation once that PR is merged. Just let me know when I can pull and I'll add a commit for HydroShare. It looks like entries will need to be added only for doc/developer/repoproviders.rst and doc/reference/repoproviders.rst

@choldgraf
Copy link
Member

choldgraf commented Dec 5, 2019

OK, we just got #1017 merged, so can you follow the instructions here:

https://binderhub.readthedocs.io/en/latest/developer/repoproviders.html#adding-a-new-repository-provider

In particular the bit about documenting this repoprovider, and then we can merge?

cc @sblack-usu

@betatim
Copy link
Member

betatim commented Dec 6, 2019

Anything left to do here before merging?

The repo2docker PR is still outstanding so that needs taking care of.

@bitnik
Copy link
Collaborator

bitnik commented Dec 6, 2019

I think this is not ready to merge. get_resolved_spec and get_resolved_ref_url methods are not defined and they are used during build process:

self.ref_url = await provider.get_resolved_ref_url()
resolved_spec = await provider.get_resolved_spec()

I think same applies for DataverseProvider PR.

@sblack-usu
Copy link
Contributor Author

Those look like they were added 10 days ago, they were not part of the RepoProvider class when I submitted. I'll go ahead and see about implementing them along with adding the new documentation today.


async def get_resolved_ref_url(self):
# Hydroshare does not provide a history, resolves to repo url
return self.get_repo_url()
Copy link
Contributor Author

Choose a reason for hiding this comment

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

get_resolved_spec and get_resolved_ref_url were two methods that I've implemented since the original review. With what I gleaned from the documentation, resolving to get_repo_url() made sense for HydroShare. If this is incorrect, I'll need suggestions to guide a different implementation.

@sblack-usu
Copy link
Contributor Author

I've resolved the merge conflicts. I'll be testing the newly merged code with a full deploy of this branch and the repo2docker changes tomorrow.

@choldgraf
Copy link
Member

Great - let us know how it goes!

@sblack-usu
Copy link
Contributor Author

Sorry about taking a little longer to get around to testing a full deploy of this. We got it deployed and tested today. It's ready to be merged along with the repo2docker changes.

@choldgraf choldgraf merged commit 0a0c0ca into jupyterhub:master Feb 3, 2020
@choldgraf
Copy link
Member

ok these are both merged - I guess now we wait for this to make it into mybinder.org and see how hydroshare repos work?

@sblack-usu
Copy link
Contributor Author

Sounds good @choldgraf and thanks for merging. I did a deploy and tested the hydroshare repo on google cloud on Friday, so I expect mybinder.org to work fine. Let me know when it's deployed and I can run some manual tests.

@choldgraf
Copy link
Member

OK I just merged into mybinder.org, so give it a whirl after a few minutes when it is done deploying

@jhamman
Copy link

jhamman commented Feb 3, 2020

Thanks @sblack-usu for sticking with this one!

@sblack-usu
Copy link
Contributor Author

I was able to build from a hydroshare resource, thanks for pushing this through.

@choldgraf
Copy link
Member

hooray! 🎉🎉🎉🎉

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.

None yet

6 participants