licenses: store not only the path to the license file, but also the identifier in source.json

[henderkes]

It's a bit of manual labour once, but it will come in handy later.

[crazywhalecc]

btw what do you think the license configuration should be associated with, the source (artifact-source) or the lib (package)?

[henderkes]

the package to be honest, what source we get it from is secondary. However, the source.json has to declare the path.

[crazywhalecc]

It sounds like:

pkg.*.json:

{
    "foo": {
        "type": "library",
        "artifact": "foo",
        "license": "MIT" // or Apache-2.0, GPL-2.0, custom, etc....
    }
}

artifact.json:

{
    "foo": {
        "source": {
            "type": "url",
            "url": "https://example.com/xxx.tgz"
        },
        "meta": [ // some source file identifier or extra config
            { "type": "license", "path": "LICENSE" }, // for general LICENSE file
            { "type": "license", "path": "{registry_root}/src/globals/licenses/foo.txt" }, // for text LICENSE (store in src)
            { "type": "source-root", "path": "subdir/to/source" } // TODO: for future custom source in subdir of dir
        ]
    }
}

The reason I want to make meta as the same level of source and binary, is to let pre-built content can also contain license file for dumping.

[crazywhalecc]

If you agree with it, I'll mark this as 3.0 task later.

[henderkes]

It sounds like:

pkg.*.json:

{
"foo": {
"type": "library",
"artifact": "foo",
"license": "MIT" // or Apache-2.0, GPL-2.0, custom, etc....
}
}

Yes, perfect!

artifact.json:

{
"foo": {
"source": {
"type": "url",
"url": "https://example.com/xxx.tgz"
},
"meta": [ // some source file identifier or extra config
{ "type": "license", "path": "LICENSE" }, // for general LICENSE file
{ "type": "license", "path": "{registry_root}/src/globals/licenses/foo.txt" }, // for text LICENSE (store in src)
{ "type": "source-root", "path": "subdir/to/source" } // TODO: for future custom source in subdir of dir
]
}
}

I think we should keep this called "source.json" or "sources.json". Artifact is too generic to describe that it's the definition where to source them from.

I'm also confused why this has meta source and source-root?

The reason I want to make meta as the same level of source and binary, is to let pre-built content can also contain license file for dumping.

[crazywhalecc]

I think we should keep this called "source.json" or "sources.json". Artifact is too generic to describe that it's the definition where to source them from.

You can take a look for v3 version. All the downloadable things will be called artifact, including:

• source code (source)
• pre-built libraries (pre-built -> binary)
• non-buildable executables like upx (pkg -> binary)

The example JSON provided above is written in the v3 format.

[crazywhalecc]

I'm also confused why this has meta source and source-root?

My goal is to let the meta field store identifiers for specific functional files, such as licenses, initial compilation directories, etc. We can visit these configs using API $artifact->getLicenseFile(), $artifact->getSourceDir().