From 018e69f1ed5931810674172d1d102ef37fe7eed8 Mon Sep 17 00:00:00 2001 From: Fabio Bonelli Date: Thu, 14 Aug 2025 10:26:03 +0200 Subject: [PATCH 1/3] docs(standard): add organizationUri --- docs/standard/schema.core.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/standard/schema.core.rst b/docs/standard/schema.core.rst index a563c36c..71e98254 100644 --- a/docs/standard/schema.core.rst +++ b/docs/standard/schema.core.rst @@ -94,6 +94,28 @@ contain the ``url`` of the original project(s). The existence of this key identifies the fork as a software variant, descending from the specified repositories. +Key ``organizationUri`` +~~~~~~~~~~~~~~~~~~~~~~~ + +- Type: string +- Presence: optional +- Example: ``"https://example.org/my-organization"``, ``"urn:x-foobar:my-organization"`` + +The URI identifying the organization owning the software. The value +SHOULD be a stable, resolvable URI or a persistent identifier. + +Parsers MAY use the URI structure to extract additional information if it follows a +recognized format (for example, inferring an institutional domain or an +official code). + +It is RECOMMENDED that crawlers and consumers of publiccode.yml verify this +information out-of-band, to ensure that the declared `organizationUri` actually +corresponds to the organization in control of the repository. +The specific verification method depends on the implementation and policies of the +platform consuming the file. + +The key can be omitted if no such URI is available. + Key ``softwareVersion`` ~~~~~~~~~~~~~~~~~~~~~~~ From 1b3d34872946b06306da0ef6cdb9d6caf7fd79fe Mon Sep 17 00:00:00 2001 From: Fabio Bonelli Date: Thu, 25 Sep 2025 09:44:40 +0200 Subject: [PATCH 2/3] docs(standard): rename organizationUri to organisationUri --- docs/standard/schema.core.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/standard/schema.core.rst b/docs/standard/schema.core.rst index 71e98254..f8fd1a43 100644 --- a/docs/standard/schema.core.rst +++ b/docs/standard/schema.core.rst @@ -94,14 +94,14 @@ contain the ``url`` of the original project(s). The existence of this key identifies the fork as a software variant, descending from the specified repositories. -Key ``organizationUri`` +Key ``organisationUri`` ~~~~~~~~~~~~~~~~~~~~~~~ - Type: string - Presence: optional -- Example: ``"https://example.org/my-organization"``, ``"urn:x-foobar:my-organization"`` +- Example: ``"https://example.org/my-organisation"``, ``"urn:x-foobar:my-organisation"`` -The URI identifying the organization owning the software. The value +The URI identifying the organisation owning the software. The value SHOULD be a stable, resolvable URI or a persistent identifier. Parsers MAY use the URI structure to extract additional information if it follows a @@ -109,8 +109,8 @@ recognized format (for example, inferring an institutional domain or an official code). It is RECOMMENDED that crawlers and consumers of publiccode.yml verify this -information out-of-band, to ensure that the declared `organizationUri` actually -corresponds to the organization in control of the repository. +information out-of-band, to ensure that the declared `organisationUri` actually +corresponds to the organisation in control of the repository. The specific verification method depends on the implementation and policies of the platform consuming the file. From f5397df917e6f5166b05b34ae09246b619d22eae Mon Sep 17 00:00:00 2001 From: Fabio Bonelli Date: Mon, 29 Sep 2025 08:38:25 +0200 Subject: [PATCH 3/3] docs(standard): turn into an object, add name, clarify publisher, deprecate repoOwner and codiceIpa --- docs/standard/schema.core.rst | 67 ++++++++++++++++++++++------------- docs/standard/schema.it.rst | 6 ++-- 2 files changed, 47 insertions(+), 26 deletions(-) diff --git a/docs/standard/schema.core.rst b/docs/standard/schema.core.rst index f8fd1a43..a6716fd5 100644 --- a/docs/standard/schema.core.rst +++ b/docs/standard/schema.core.rst @@ -94,28 +94,6 @@ contain the ``url`` of the original project(s). The existence of this key identifies the fork as a software variant, descending from the specified repositories. -Key ``organisationUri`` -~~~~~~~~~~~~~~~~~~~~~~~ - -- Type: string -- Presence: optional -- Example: ``"https://example.org/my-organisation"``, ``"urn:x-foobar:my-organisation"`` - -The URI identifying the organisation owning the software. The value -SHOULD be a stable, resolvable URI or a persistent identifier. - -Parsers MAY use the URI structure to extract additional information if it follows a -recognized format (for example, inferring an institutional domain or an -official code). - -It is RECOMMENDED that crawlers and consumers of publiccode.yml verify this -information out-of-band, to ensure that the declared `organisationUri` actually -corresponds to the organisation in control of the repository. -The specific verification method depends on the implementation and policies of the -platform consuming the file. - -The key can be omitted if no such URI is available. - Key ``softwareVersion`` ~~~~~~~~~~~~~~~~~~~~~~~ @@ -310,6 +288,45 @@ The keys are: configuration files, bash scripts, ansible playbooks, Dockerfiles, or other instruction sets. +Section ``organisation`` +~~~~~~~~~~~~~~~~~~~~~~~~ + +This optional section provides the organisation publishing the software. + +Key ``organisation/uri`` +''''''''''''''''''''''' + +- Type: string +- Presence: mandatory +- Example: ``"https://example.org/my-organisation"``, ``"urn:x-foobar:my-organisation"`` + +The URI identifying the organisation publishing the software. The value +SHOULD be a stable, resolvable URI or a persistent identifier. + +Parsers MAY use the URI structure to extract additional information if it follows a +recognized format (for example, inferring an institutional domain or an +official code). + +It is RECOMMENDED that crawlers and consumers of publiccode.yml verify this +information out-of-band, to ensure that the declared `organisationUri` actually +corresponds to the organisation in control of the repository. +The specific verification method depends on the implementation and policies of the +platform consuming the file. + +Key ``organisation/name`` +''''''''''''''''''''''' + +- Type: string +- Presence: optional +- Example: ``"My organisation"`` + +The canonical name of the organisation publishing the software. + +It MUST correspond to the same entity identified by ``organisation/uri`` and is +intended to provide a human-readable label for that URI. +It SHOULD be the canonical, widely recognized form of the name (such as the +registered legal or institutional name). + Section ``intendedAudience`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -582,8 +599,8 @@ In case it is not possible to name a main copyright owner, it is possible to omit this key; in those cases, if the repo has a authors file, you can point to it through ``legal/authorsFile``. -Key ``legal/repoOwner`` -''''''''''''''''''''''' +Key ``legal/repoOwner`` (*deprecated*) +'''''''''''''''''''''''''''''''''''''' - Type: string - Presence: optional @@ -594,6 +611,8 @@ or might not be the same entity who owns the copyright on the code itself. For instance, in case of a fork of the original software, the ``repoOwner`` is probably different from the ``mainCopyrightOwner``. +This key is deprecated, use ``organisation/name`` instead. + Key ``legal/authorsFile`` (*deprecated*) '''''''''''''''''''''''''''''''''''''''' diff --git a/docs/standard/schema.it.rst b/docs/standard/schema.it.rst index 9213685e..f8bc1e2c 100644 --- a/docs/standard/schema.it.rst +++ b/docs/standard/schema.it.rst @@ -125,8 +125,8 @@ Section ``riuso`` This section contains a set of keys related to the publication of the software inside the reuse catalog of `Developers Italia `__. -Chiave ``riuso/codiceIPA`` -'''''''''''''''''''''''''' +Chiave ``riuso/codiceIPA`` (*deprecated*) +''''''''''''''''''''''''''''''''''''''''' - Type: string (iPA code) - Presence: mandatory if ``repoOwner`` is a Public Administration @@ -134,3 +134,5 @@ Chiave ``riuso/codiceIPA`` This key represents the administration code inside the Public Administration index (codice IPA). + +This key is deprecated, use ``organisation/uri`` instead.