Update readme with godeps info. #7095

Merged
merged 2 commits into from Mar 14, 2017

Conversation

Projects
None yet
3 participants
Member

anastasiamac commented Mar 14, 2017

Please provide the following details to expedite Pull Request review:


Description of change

Readme file needs to have godeps info to ensure that juju builds do not fail for new comers. Copied extract from Contributing doc verbatum.

QA steps

n/a

Documentation changes

n/a

Bug reference

https://bugs.launchpad.net/juju/+bug/1668899

axw approved these changes Mar 14, 2017

I think we should probably update the Makefile to run godeps by default, and invert the flag to disable rather than enable. That would be more helpful to newcomers.

README.md
@@ -84,6 +84,55 @@ This will add some PPAs to ensure that you can install the required
golang and mongodb-server versions for precise onwards, in addition to the
other dependencies.
+The recommended way to get dependencies is using godeps, see Dependency management section.
@axw

axw Mar 14, 2017

Member

It's not clear what this has to do with the above. Can you please clarify a little bit further, e.g.:

make install-dependencies" will install runtime dependencies. To build Juju, you must also ensure you have the appropriate build dependencies. To get the build dependencies, ...

README.md
+godeps
+------
+
+[godeps](https://launchpad.net/godeps) is the tool that does the freezing.
@axw

axw Mar 14, 2017

Member

can you please fix the URL while you're there, to match the one below

Member

anastasiamac commented Mar 14, 2017

$$merge$$

Contributor

jujubot commented Mar 14, 2017

Status: merge request accepted. Url: http://juju-ci.vapour.ws:8080/job/github-merge-juju

@jujubot jujubot merged commit e2f8bb3 into juju:2.1 Mar 14, 2017

@anastasiamac anastasiamac deleted the anastasiamac:readme-update-lp1668899 branch Mar 14, 2017

jujubot added a commit that referenced this pull request Mar 23, 2017

Merge pull request #7141 from wallyworld/merge-2.1-23032017
Merge 2.1 tip into develop

Merge latest 2.1 changes into develop branch. Includes:
- PR #7010 Don't leave charm files sitting in the cache
- PR #7094 Changes for bug 1671265
- PR #7095 Update readme with godeps info
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment