-
Notifications
You must be signed in to change notification settings - Fork 1k
FAQ entry for issue #856, (anyway I *think* this is how it works) #863
Conversation
FAQ.md
Outdated
|
||
## One or more of my dependencies doesn't tag its releases. What should I do? | ||
|
||
Simply add a constrainit to your manifest that specifies `"branch": "master"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
spelling: constraint
FAQ.md
Outdated
## One or more of my dependencies doesn't tag its releases. What should I do? | ||
|
||
Simply add a constrainit to your manifest that specifies `"branch": "master"` | ||
for the dependency. Dep will deduce the current revision number of your |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
use dep
not Dep, I think.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just two small changes. Thank you for tackling this so quickly!
FAQ.md
Outdated
@@ -34,6 +34,7 @@ Summarize the question and quote the reply, linking back to the original comment | |||
* [What semver version should I use?](#what-semver-version-should-i-use) | |||
* [Is it OK to make backwards-incompatible changes now?](#is-it-ok-to-make-backwards-incompatible-changes-now) | |||
* [My dependers don't use `dep` yet. What should I do?](#my-dependers-dont-use-dep-yet-what-should-i-do) | |||
* [One or more of my dependencies doesn't tag its releases. What should I do?](#one-or-more-of-my-dependencies-dont-tag-their-releases-what-should-i-do) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's simplify the question to "How do I configure a dependency that doesn't tag its releases?"
FAQ.md
Outdated
|
||
## One or more of my dependencies doesn't tag its releases. What should I do? | ||
|
||
Simply add a constraint to your manifest that specifies `"branch": "master"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove "simply", changing it to "Add a constraint...". I don't want anyone feeling bad about themselves if this doesn't feel simple! 😀
Don't worry about the PR status checks by the way! Github has a bug at the moment which is making them fail when the PR is just fine. |
The toc formatting got messed up with extra hyphens
FAQ.md
Outdated
|
||
## How do I configure a dependency that doesn't tag its releases? | ||
|
||
Add a constraint to your manifest that specifies `"branch": "master"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ooops, I missed this the first time around but it should be branch = "master"
in order to be proper TOML.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
blerg sorry.
FAQ.md
Outdated
@@ -34,8 +34,7 @@ Summarize the question and quote the reply, linking back to the original comment | |||
* [What semver version should I use?](#what-semver-version-should-i-use) | |||
* [Is it OK to make backwards-incompatible changes now?](#is-it-ok-to-make-backwards-incompatible-changes-now) | |||
* [My dependers don't use `dep` yet. What should I do?](#my-dependers-dont-use-dep-yet-what-should-i-do) | |||
|
|||
___ | |||
* [How do I configure a dependency that doesn't tag its releases?](#how-do-I-configure-a-dependency-that-doesnt-tag-its-releases) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One more change, I swear! Thank you for sticking with me. 😁
The link isn't scrolling down the page to the right section because of the upper-case "I" in the url. It should be this #how-do-i-configure-a-dependency-that-doesnt-tag-its-releases
.
I tried to "help" before by adding a commit to your PR but I think that made it harder... Sorry about that!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
np really. Making epics of what should be a simple change is my superpower
omg. I actually can't believe I just did that standby.. |
So there's good news and bad news. 👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there. 😕 The bad news is that it appears that one or more commits were authored by someone other than the pull request submitter. We need to confirm that they're okay with their commits being contributed to this project. Please have them confirm that here in the pull request. Note to project maintainer: This is a terminal state, meaning the |
Not sure why it thinks I didn't sign the cla (I did) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sdboyer Would you please do a squash and merge for us?
Don't worry about the CLA, there's a bug at the moment which is causing it to fail. Thanks again for the PR! 💖 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
some quick changes, first...
FAQ.md
Outdated
|
||
Add a constraint to your manifest that specifies `branch: "master"` | ||
for the dependency. `dep` will deduce the current revision number of your | ||
dependencies master branch, and place it the lock-file (`Gopkg.lock`) for you. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/dependencies/dependency's/
FAQ.md
Outdated
## How do I configure a dependency that doesn't tag its releases? | ||
|
||
Add a constraint to your manifest that specifies `branch: "master"` | ||
for the dependency. `dep` will deduce the current revision number of your |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/dep
/dep ensure
/ - just to make it clear what phase (e.g., not before dep init
) in which this guidance applies.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, s/revision number/revision/
FAQ.md
Outdated
Add a constraint to your manifest that specifies `branch: "master"` | ||
for the dependency. `dep` will deduce the current revision number of your | ||
dependencies master branch, and place it the lock-file (`Gopkg.lock`) for you. | ||
Anyone who clones your project will, therefore, wind up with same version of the dependency, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure this is quite what we want to be saying here. Committing vendor
is what would guarantee this at clone time; having the rev in your Gopkg.lock
only guarantees that vendor
will be populated with it by dep ensure
(assuming no other changes).
Just the last sentence, referring the reader to the other question, is probably sufficient.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tiny nit, then needs a rebase, then we're good 😄
FAQ.md
Outdated
## How do I configure a dependency that doesn't tag its releases? | ||
|
||
Add a constraint to your manifest that specifies `branch: "master"` | ||
for the dependency. `dep ensure` will deduce the current revision of your |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
eh, one last tiny nit - we often use "deduce" to mean a specific thing in the dep/gps world. there's nothing wrong with this usage here, but if you did s/determine/deduce/, it would help avoid any possible inferred relationship forming in the mind of the reader between the deduction subsystem (if they know about it) and figuring out the underlying rev of a branch.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i have some small tweaks to make, but i'll do those directly rather than having this languish further. sorry for the slowness!
oh wait, conflicts. ok, i'll fix directly, then push 😄 |
@djosephsen thank you! |
What does this do / why do we need it?
Just some words for the faq / Because you asked for them in #856
What should your reviewer look out for in this PR?
no sharp edges here.
Do you need help or clarification on anything?
Nope 👍
Which issue(s) does this PR fix?
#865