Skip to content

add bower link instructions to README #1957

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

Merged

Conversation

benjaminapetersen
Copy link
Contributor

Adds a block under Contributing for using bower link to work in our other repos.

@jeff-phillips-18
@spadgett

README.md Outdated
$ bower link
$ cd ~/git-repos/origin-web-catalog
$ bower link
$ cd ~?git-repos/origin-web-console
Copy link
Member

Choose a reason for hiding this comment

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

? should be /

Copy link
Contributor Author

Choose a reason for hiding this comment

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

+1 got it

$ bower link
$ cd ~/git-repos/origin-web-console
$ bower link origin-web-common
$ bower link origin-web-catalog
Copy link
Member

@spadgett spadgett Aug 21, 2017

Choose a reason for hiding this comment

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

Do we need to tell people how to unlink? Will you have built dist conflicts if you don't?

@jeff-phillips-18 may know better

Copy link
Contributor Author

Choose a reason for hiding this comment

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

bower link is just a symlink bower maintains so it shouldn't blow up across bower installs, etc.

You can definitely have /dist conflicts if one of the linked repos is on another branch, etc.

bower unlink is an alias of bower uninstall, which just removes the dependency for a re-install the normal way.

We can outline all of this if you think its necessary.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated, how about this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Working out the kinks of it right now on other branches 😄

Copy link
Member

Choose a reason for hiding this comment

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

You can definitely have /dist conflicts if one of the linked repos is on another branch, etc.

Even if master is ahead of the tagged version that origin-web-console uses, wouldn't it cause a dist mismatch? So we'd need instructions for dealing with that

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm, yeah this is problematic. Options:

  • Clone origin-web-console twice, have a copy with the bower links to work on the other repos. Wheeeee.....
  • See if we can improve on unit/integration testing instead of doing all this link stuff to manually verify things work as intended
  • Setup a little demo app in the secondary repos to manually test against
  • ???

All the options have a little bit of janky workflow in them.

README.md Outdated
# may end up with frequent `/dist` conflicts as `grunt build` will use the linked local copy
# in whatever state it happens to be in.
```
Alternatively, you could `cd` into `/origin-web-console/bower_components` and create symlinks for `origin-web-catalog` and `origin-web-common`, but you will likely have to recreate these each time you `bower install`.
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 we can just leave this out since bower link just seems better

README.md Outdated
# you will likely have to `grunt build` to see the updates.
#
# Reduce your complexity and clean up:
# when you have finished your work, `bower unlink <repo>` & `bower install` to return to using
Copy link
Member

Choose a reason for hiding this comment

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

Does that work? I'm thinking it might remove the dependency entirely from bower.json.

Let's just recommend

$ hack/clean-assets.sh
$ hack/install-assets.sh

to clean up.

@benjaminapetersen
Copy link
Contributor Author

updated

@spadgett
Copy link
Member

[merge][severity: lowrisk]

@openshift-bot
Copy link

Evaluated for origin web console merge up to 31b80c1

@openshift-bot
Copy link

openshift-bot commented Sep 11, 2017

Origin Web Console Merge Results: SUCCESS (https://ci.openshift.redhat.com/jenkins/job/merge_pull_request_origin_web_console/161/) (Base Commit: 240041d) (PR Branch Commit: 31b80c1) (Extended Tests: lowrisk)

@openshift-bot openshift-bot merged commit 6633f9c into openshift:master Sep 11, 2017
@benjaminapetersen benjaminapetersen deleted the bpeterse/readme-update branch September 12, 2017 03:59
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.

4 participants