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

Rename [[dependencies]] to [[constraint]] #538

Merged
merged 5 commits into from May 27, 2017

Conversation

Projects
None yet
5 participants
@felipeweb
Copy link
Contributor

felipeweb commented May 10, 2017

related issue #509

felipeweb added some commits May 9, 2017

@googlebot googlebot added the cla: yes label May 10, 2017

@sdboyer
Copy link
Member

sdboyer left a comment

looks pretty good, thank you!!! 🎉

one wording nit, then a request for a bit more work 😄

@@ -36,9 +36,9 @@ const exampleTOML = `
## or in a dependency.
# ignored = ["github.com/user/project/badpkg"]
## Dependencies define constraints on dependent projects. They are respected by
## Constraint define constraints on dependent projects. They are respected by

This comment has been minimized.

@sdboyer

sdboyer May 10, 2017

Member

This stutters a bit now, with the repetition of constraint. Let's modify the first sentence to read:

Constraints are rules for how directly imported projects may be incorporated into the depgraph.

manifest.go Outdated
Ignored []string `toml:"ignored,omitempty"`
Required []string `toml:"required,omitempty"`
Constraints []rawProject `toml:"constraint,omitempty"`
Overrides []rawProject `toml:"overrides,omitempty"`

This comment has been minimized.

@sdboyer

sdboyer May 10, 2017

Member

As long as we're in here changing things, let's also change [[overrides]] to the singular, [[override]] (but keep the property name plural, rawManifest.Overrides).

@felipeweb felipeweb force-pushed the felipeweb:issue_509 branch 3 times, most recently from c87e45d to 065c23f May 10, 2017

@felipeweb felipeweb force-pushed the felipeweb:issue_509 branch from 065c23f to 5cb3e51 May 10, 2017

@felipeweb

This comment has been minimized.

Copy link
Contributor

felipeweb commented May 10, 2017

@sdboyer done!

@sdboyer

This comment has been minimized.

Copy link
Member

sdboyer commented May 10, 2017

OK, this is looking good - thank you! I'm going to wait on merging until we get the other breaking changes sorted, then do them as a batch.

## Overrides have the same structure as [[dependencies]], but supercede all
## [[dependencies]] declarations from all projects. Only the current project's
## [[overrides]] are applied.
## Override have the same structure as [[constraint]], but supercede all

This comment has been minimized.

@aaronbee

aaronbee May 11, 2017

"Override" should probably be "Overrides" here to be grammatically correct and consistent with line 15.

Or, this sentence could be "Override has ..." and line 15 can be changed to "Constraint is a rule ..."

This comment has been minimized.

@sdboyer

sdboyer May 11, 2017

Member

Agreed, the former is preferred, primarily for consistency.

##
## Overrides are a sledgehammer. Use them only as a last resort.
# [[overrides]]
## Override is a sledgehammer. Use them only as a last resort.

This comment has been minimized.

@aaronbee

aaronbee May 11, 2017

"Override is a sledgehammer. Use it only as a last resort."

or

"Overrides are a sledgehammer. Use them only as a last resort."

This comment has been minimized.

@sdboyer

sdboyer May 11, 2017

Member

The latter, please 😄

@sdboyer

This comment has been minimized.

Copy link
Member

sdboyer commented May 11, 2017

Gotta chase the conflicts :/

FYI, I'm planning on merging this into a feature branch. Hopefully a short-lived one - I'm aiming for only until Monday.

@zkanda

This comment has been minimized.

Copy link
Contributor

zkanda commented May 21, 2017

Hello, what's the status of this? I can fix the conflict and willing to take it forward on getting merge.

@sdboyer sdboyer added this to the Manifest and Lock committable milestone May 21, 2017

@sdboyer

This comment has been minimized.

Copy link
Member

sdboyer commented May 21, 2017

Bleh, yeah, the conflict will need fixing.

The status is that this is waiting to be merged simultaneously with a number of other issues that will be the last backwards-compatibility break with Gopkg.toml and Gopkg.lock. Unfortunately, they weren't all quite ready last week, so the merging of this was delayed.

At present, all that's left is #225 and a small addition to #584 that incorporates #421 - that, and, I need to write up some release notes + caveat emptor.

@sdboyer

This comment has been minimized.

Copy link
Member

sdboyer commented May 23, 2017

FYI, this has been incorporated into the stabilize-files branch, which we'll merge all at once when everything in #277 is ready.

@sdboyer sdboyer merged commit 5cb3e51 into golang:master May 27, 2017

3 of 4 checks passed

cla/google CLAs are signed, but unable to verify author consent
codeclimate no new or fixed issues
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

ibrasho added a commit to ibrasho-forks/dep that referenced this pull request Jun 10, 2017

Update the FAQ to reflect golang#538. (use constraint instead of depe…
…ndencies)

[[dependencies]] was changed to [[constraint]] but the FAQ had answers
that used the old field.

Signed-off-by: Ibrahim AshShohail <ibra.sho@gmail.com>

sdboyer added a commit that referenced this pull request Jun 12, 2017

Merge pull request #739 from ibrasho-forks/update-FAQ
Update the FAQ to use constraint instead of dependencies (reflect #538)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment