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

add key components #169

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/standard/example/publiccode.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ publiccodeYmlVersion: "0.4"
name: Medusa
applicationSuite: MegaProductivitySuite
url: "https://example.com/italia/medusa.git"
components:
- "https://example.com/italia/stheno.git"
- "https://example.com/italia/euryale.git"
landingURL: "https://example.com/italia/medusa"
isBasedOn: "https://github.com/italia/otello.git"
softwareVersion: "1.0"
Expand Down
17 changes: 17 additions & 0 deletions docs/standard/schema.core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ Key ``applicationSuite``

This key contains the name of the “suite” to which the software belongs.

.. _key-url:

Key ``url``
~~~~~~~~~~~

Expand All @@ -64,6 +66,21 @@ See :ref:`forks-and-variants` for a complete description of what
is a software variant and how to handle forked software as a parser or
an author.

Key ``components``
~~~~~~~~~~~~~~~~~~

- Type: array of strings (URLs)
- Presence: optional

Some software projects are organized in more than one repository.
In addition to :ref:`key-url`, this key gives you an option to specify
more than one URL to further repositories, that are essential parts of
the software (e.g. one repository for the frontend and another repository
for the backend).

If you use the key, you need to specify the URL in the same way as
is required for the key ``url``. You can specify more than one URL.

Key ``landingURL``
~~~~~~~~~~~~~~~~~~

Expand Down