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

chore: reuse ipld-explorer as git submodule #771

Closed
wants to merge 1 commit into from

Conversation

olizilla
Copy link
Member

This is the shortest path to re-using the ipld explorer code
in webui. Publishing ipld explorer as a reuseable module needs
more thought, and right now we want to be able to build and
edit all of the webui code from a single code base, while we
do the polishing for release.

To test it out, checkout ipld-explore-as-git-submodule and do the submodule dance

git checkout ipld-explore-as-git-submodule 
git submodule init
git submodule update

You only need to do that the once.

If you then need to edit ipld explorer code for the web ui project, you can cd into the explore directory, and you are now working in the scope of the ipld-explore repo. You'd make your changes there, as if you were working directly against the ipld-explorer repo (you are) and branch and push from inside the explore sub dir. Remeber that your changes need to make sense for both the standalone app and the webui. Once your happy with and you've pushed your ipld explorer changes, you can cd back up to the webui root, and run git status and you'll see something like

$ git status
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git checkout -- <file>..." to discard changes in working directory)

	modified:   src/explore (new commits)

Which tells us that the ipld explore submodule in your local workspace has your new changes, but the submodule pointer from the parent webui project needs updating. If you add, commit and PR that change to webui, then you share that "update ipld explorer to this commit" with the team.

I already hate this, so will be working on a better solution asap.

In the future ipld explorer may become one app in a learna repo
for all the webui sections, or we might focus on a post-message
api to co-ordinate ipfs apps via iframes with webui orchestrating
things and providing the ipfs instance to child frames.

License: MIT
Signed-off-by: Oli Evans oli@tableflip.io

This is the shortest path to re-using the ipld explorer code
in webui. Publishing ipld explorer as a reuseable module needs
more thought, and right now we want to be able to build and
edit all of the webui code from a single code base, while we
do the polishing for release.

In the future ipld explorer may become one app in a learna repo
for all the webui sections, or we might focus on a post-message
api to co-ordinate ipfs apps via iframes with webui orchestrating
things and providing the ipfs instance to child frames.

License: MIT
Signed-off-by: Oli Evans <oli@tableflip.io>
@hacdias
Copy link
Member

hacdias commented Sep 10, 2018

I believe we can close this @olizilla

@olizilla
Copy link
Member Author

Better solution in #781

@olizilla olizilla closed this Sep 10, 2018
@hacdias hacdias deleted the ipld-explore-as-git-submodule branch September 10, 2018 10:50
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.

2 participants