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

"revision" and "version" terms are mixed in codebase and presented poorly in the UI/docs #181

Open
SeanTAllen opened this issue Mar 13, 2021 · 1 comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed needs investigation This needs to be looked into before its "ready for work"

Comments

@SeanTAllen
Copy link
Member

See below:

~/tmp/foo ➜ corral add github.com/seantallen/lori.git --revision 0.0.1
~/tmp/foo ➜ cat corral.json
{
  "packages": [],
  "deps": [
    {
      "locator": "github.com/seantallen/lori.git",
      "version": ""
    }
  ],
  "info": {
    "description": "",
    "homepage": "",
    "license": "",
    "documentation_url": "",
    "version": "",
    "name": ""
  }
}

I'm not sure given that "version" can take a a revision that we need both version and revision. And we have no rules in place for how one overrides the other if both are present (or rather we have no stated rules). I wonder if version override revision and because we are doing an empty version now, revision doesn't appear.

@SeanTAllen SeanTAllen added help wanted Extra attention is needed good first issue Good for newcomers needs investigation This needs to be looked into before its "ready for work" labels Mar 13, 2021
@SeanTAllen
Copy link
Member Author

Huh so ok, what is going on here is that --revision sets what goes into the lock.json and --version sets what goes into the corral.json.

So version can be a semantic constraint and revision would lock it to a specific version.

The interface to do this is a bit confusing to me. It seems like it could easily get out of shape as corral will let me set a revision that is outside a version constraint. Which should end up being "not doable".

corral add github.com/seantallen/lori.git --version 0.0.1 --revision 0.0.2

as an example.

@SeanTAllen SeanTAllen changed the title --revision option to add does nothing "revision" and "version" terms are mixed in codebase and presented poorly in the UI/docs Mar 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed needs investigation This needs to be looked into before its "ready for work"
Projects
None yet
Development

No branches or pull requests

1 participant