Skip to content
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

Use YAML syntax for remote git location identification. #254

Merged
merged 1 commit into from
Jun 10, 2015

Conversation

mboes
Copy link
Contributor

@mboes mboes commented Jun 10, 2015

As suggested by @greggwebs. The syntax proposed yesterday has the
advantage of concision, but using YAML syntax for the different
components adds marginal verbosity. As it is, the previous syntax made
extensibility problematic, whereas that's exactly where YAML
shines (what if we need an extra field to identify a particular git
commit?). Further, using YAML means people are free to include their own
metadata about package locations, without disturbing Stack.

Here's an example:

- location:
    git: https://github.com/kolmodin/binary
    commit: 8debedd3fcb6525ac0d7de2dd49217dce2abc0d9

Note that this patch removes the old syntax. The reasoning being -
custom user tooling would need to conservatively support both syntaxes
if there was a brief and a long syntax, because it can't assume that
other users utilized the easier to parse syntax.

As suggested by @greggwebs. The syntax proposed yesterday has the
advantage of concision, but using YAML syntax for the different
components adds marginal verbosity. As it is, the previous syntax made
extensibility problematic, whereas that's exactly where YAML
shines (what if we need an extra field to identify a particular git
commit?). Further, using YAML means people are free to include their own
metadata about package locations, without disturbing Stack.

Here's an example:

- location:
    git: https://github.com/kolmodin/binary
    commit: 8debedd3fcb6525ac0d7de2dd49217dce2abc0d9
@mboes
Copy link
Contributor Author

mboes commented Jun 10, 2015

cc @gregwebs @3noch. Followup to #199.

@snoyberg
Copy link
Contributor

Properly pinging @gregwebs instead :)

@chrisdone
Copy link
Member

Looks reasonable to me.

snoyberg added a commit that referenced this pull request Jun 10, 2015
Use YAML syntax for remote git location identification.
@snoyberg snoyberg merged commit 829462e into master Jun 10, 2015
@snoyberg snoyberg deleted the remote-git-syntax branch June 10, 2015 08:55
@snoyberg
Copy link
Contributor

Me too, I agree on the reasoning as well.

@gregwebs
Copy link
Contributor

Great!
On Jun 10, 2015 1:55 AM, "Michael Snoyman" notifications@github.com wrote:

Me too, I agree on the reasoning as well.


Reply to this email directly or view it on GitHub
#254 (comment)
.

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