merge into jupyter_contrib_nbextensions

[jcb91]

So, as discussed in #5 (comment), I think we're now ready to merge this into ipython-contrib/jupyter_contrib_nbextensions? Or do we still have pending readme updates? I've slightly lost track 😆

[jfbercher]

Yep, for the READMEs it is ok. I have just pushed the update to display an alert in case of missing kernel dependency. Otherwise it is ok and I let you do the push to ipython-contrib/jupyter_contrib_nbextensions :-)

[jcb91]

Wait, are we renaming the library? I only ask because renames make merges more difficult to handle later on...

[jfbercher]

Well, I understand that renaming will lead to difficulty. Since all the story began with code_prettify we can still consider it as the base directory, which includes the new lib and derived nbextensions.

[jcb91]

OK, the terminal history for me making the correct pr is below (the first time round, I just forgot the nbextensions directory in the contrib package 😢

# setup initial state, I only do this once
git clone https://github.com/jcb91/jupyter_contrib_nbextensions.git
cd jupyter_contrib_nbextensions
git remote rename origin jcb91
git remote add contrib https://github.com/ipython-contrib/jupyter_contrib_nbextensions.git
git fetch --all

# now add the sub-repo remote
git remote add code_prettify https://github.com/jfbercher/code_prettify.git
git fetch code_prettify
# checkout sub-repo branch, but in our main contrib repo
git checkout -b code_prettify_renames code_prettify/master

# create the directory we will inhabit in contrib, then move everything there
mkdir -p src/jupyter_contrib_nbextensions/nbextensions/code_prettify
git mv *.* src/jupyter_contrib_nbextensions/nbextensions/code_prettify/
git commit -m "[code_prettify] renames for jupyter_contrib_nbextensions"

# now switch to main branch
git checkout -b cp_merged contrib/master

# merge the sub-repo branch into master
git merge code_prettify_renames

# if there was already something in contrib repo, we have to resolve conflicts.
# generally, I just assume that whatever is already in contrib is going to get
# overwritten by our merge from upstream, so just git-add everything.
# However, if there's stuff in contrib that isn't in upstream, this would need
# more care to ensure it got removed correctly
rm src/jupyter_contrib_nbextensions/nbextensions/code_prettify/*
git checkout code_prettify_renames -- src/jupyter_contrib_nbextensions/nbextensions/code_prettify
git commit -m "[code_prettify] merge upstream code_prettify into contrib repo version"

# get rid of the code_prettify_renames branch
git branch -D code_prettify_renames

# push the merged branch to my github contrib repo
git push --set-upstream jcb91 cp_merged

# finally, open a github PR

I used cygwin bash, but most of it is git commands, so portable anyway. I think the only stuff that wouldn't translate well to cmd would be the mv, rm and mkdir (also, I think some distributions don't have a -p flag for mkdir, but that's not such a big deal).

For future updates, using the same remotes, we should be able to just do something along the lines of

git merge code_prettify/master