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

Can url/vcs always points to a true VCS repo ? #63

Open
oliviermaridat opened this issue Jun 5, 2015 · 3 comments
Open

Can url/vcs always points to a true VCS repo ? #63

oliviermaridat opened this issue Jun 5, 2015 · 3 comments
Labels
Format Manifest Format

Comments

@oliviermaridat
Copy link

Hi there!

I am wondering about the content of the field url/vcs of the manifest files. I though it would contain a link to a usable VCS repository (to be able to do "git clone url" for example), but apparently it depends of the projects.

For example:

Is it on purpose?

@cornelius
Copy link
Owner

The idea is to have this field link to a web page with information about how the repository can be accessed. In some cases this can double as the actual clone URL (in the case of GitHub for example), but in general the page should be accessible by a browser.

Adding information about how a version control can check out the code might be nice to add, but this would need a little bit more structure, especially to support the generic case of different version control systems.

@oliviermaridat
Copy link
Author

Ok thanks, I understand better your vision here. I suppose that the "inqlude-client" is only using source URL ("packages/source"), and this is why it does not have any issue with that. Am I wrong?

If you intend to add this information, one solution may be to add a new "git"/"svn"/"hg" field in "packages". For example with Git:

 "packages": {
    "source": "https://github.com/lastfm/liblastfm/archive/1.0.8.tar.gz",
    "git": "https://github.com/lastfm/liblastfm"
  }

Or with SVN (some additional fields may be required for some project, because SVN does not support branch, tags, etc natively)

 "packages": {
    "source": "https://svnhub.com/lastfm/liblastfm/archive/1.0.8.tar.gz",
    "svn": "https://svnhub.com/lastfm/liblastfm",
    "trunk-path": "Trunk",
    "branches-path": "Branches",
    "tags-path": "Tags"
  }

Actually, it is usually possible to guess the VSC type (Git, SVN, ...) using the URL (github, ...). So a "vcs" field could be the default one, and for some project "git", "svn" or any other can be used instead.

What do you think?

@cornelius
Copy link
Owner

Yes, I think we need some explicit fields for the version control system. There actually is an item in the todo list for that: https://github.com/cornelius/inqlude/blob/master/TODO#L24

Figuring out what the best structure is needs a little bit more thought. Maybe we need an extra section as it's neither links to web pages nor actual packages.

@cornelius cornelius added the Format Manifest Format label Aug 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Format Manifest Format
Projects
None yet
Development

No branches or pull requests

2 participants