Skip to content
This repository has been archived by the owner on Apr 21, 2022. It is now read-only.

Add authors/maintainers to the specification #23

Open
lpalgarvio opened this issue Mar 5, 2017 · 5 comments
Open

Add authors/maintainers to the specification #23

lpalgarvio opened this issue Mar 5, 2017 · 5 comments

Comments

@lpalgarvio
Copy link

lpalgarvio commented Mar 5, 2017

Hello

We have Vendor, but Authors and/or Maintainers is missing in the specification.
Can we take a look at what's done in PHP Composer?

https://getcomposer.org/doc/04-schema.md#authors
`authors#

The authors of the package. This is an array of objects.

Each author object can have following properties:

name: The author's name. Usually their real name.
email: The author's email address.
homepage: An URL to the author's website.
role: The author's role in the project (e.g. developer or translator)

An example:

{
"authors": [
{
"name": "Nils Adermann",
"email": "[email protected]",
"homepage": "http://www.naderman.de",
"role": "Developer"
},
{
"name": "Jordi Boggiano",
"email": "[email protected]",
"homepage": "http://seld.be",
"role": "Developer"
}
]
}`

@lpalgarvio
Copy link
Author

lpalgarvio commented Mar 5, 2017

MAINTAINER is officially deprecated in dockerfiles.
It is not even included in docker-compose.yml files.

https://docs.docker.com/engine/reference/builder/#maintainer-deprecated

They point to implementation in labels.

@lpalgarvio lpalgarvio changed the title Add authors to the specification Add authors/maintainers to the specification Mar 5, 2017
@lpalgarvio
Copy link
Author

lpalgarvio commented Mar 5, 2017

This format is not supported in docker-compose.yml files:
`      - org.label-schema.authors:
        - "author1=bill"
        - "author2=john"`

ERROR: The Compose file './docker-compose.yml' is invalid because:
services.main.labels contains {"org.label-schema.authors": ["author1=bill", "author2=john"]}, which is an invalid type, it should be a string

But we can implement something like this:

org.label-schema.authors.bill.name=Bill Doe
[email protected]
org.label-schema.authors.bill.homepage=http://bill.example.com
org.label-schema.authors.bill.role=DevOps
org.label-schema.authors.john.name=John Doe
[email protected]
org.label-schema.authors.john.homepage=http://john.example.com
org.label-schema.authors.john.role=DevOps

@lpalgarvio
Copy link
Author

lpalgarvio commented Mar 5, 2017

Added pull request #25:

  • org.label-schema.authors.john.name = "John Doe"
  • org.label-schema.authors.john.email = "[email protected]"
  • org.label-schema.authors.john.homepage = "http://john.example.com"
  • org.label-schema.authors.john.role = "DevOps"

@lpalgarvio
Copy link
Author

lpalgarvio commented Mar 5, 2017

Similarly, vendor could be expanded to allow:

This change wouldn't break existing org.label-schema.vendor implementations.

@lpalgarvio
Copy link
Author

#36 added for vendor

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant