Skip to content
This repository has been archived by the owner on Sep 9, 2020. It is now read-only.

Improve docs for using dep in CI #1275

Closed
sudo-suhas opened this issue Oct 16, 2017 · 6 comments · Fixed by #1293
Closed

Improve docs for using dep in CI #1275

sudo-suhas opened this issue Oct 16, 2017 · 6 comments · Fixed by #1293

Comments

@sudo-suhas
Copy link
Contributor

From the readme section for current status:

dep is still changing rapidly. If you need stability (e.g. for CI), it's best to rely on a released version, not tip.

I'd like to add some documentation for using dep on travis. Here's what I have:

# ...

before_install:
  # Setup dependency management tool
  - curl -L -s https://github.com/golang/dep/releases/download/v0.3.1/dep-linux-amd64 -o $GOPATH/bin/dep
  - chmod +x $GOPATH/bin/dep

install:
  - dep ensure

What would be the right place for this?

@sdboyer
Copy link
Member

sdboyer commented Oct 18, 2017

FAQ, sadly, as that's the only place we really have for docs right now.

@sudo-suhas
Copy link
Contributor Author

Hmm.. What about the wiki? Or how about a gh-pages branch?

@sdboyer
Copy link
Member

sdboyer commented Oct 19, 2017

nope, not unless we're contemplating actually solving this problem more generally. docs need to be able to be updated as part of normal PR process, which means they have to be in-repo, and on-branch.

moreover, while we do desperately need to improve this, it needs to be an intentional, planned process, not a haphazard one for a single docs element. until we come up with a clear, intuitive rule for why certain docs go in place X vs place Y, doing one-offs solves individual cases at the cost of systemic fragmentation.

@sudo-suhas
Copy link
Contributor Author

sudo-suhas commented Oct 19, 2017

Okay. Understood. Should I add a section to the FAQ for using dep on travis?

@carolynvs
Copy link
Collaborator

Yes, please putting this into the FAQ under Best Practices would be very welcome! ❤️

@sudo-suhas
Copy link
Contributor Author

Thanks @carolynvs! Please take a look at #1293

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants