Skip to content

doc(spec): deprecate the single string form of isBasedOn #357

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.

Sign up for GitHub

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

Open
bfabio wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc(spec): deprecate the single string form of isBasedOn #357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 1 deletion docs/standard/example/publiccode.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ name: Medusa
applicationSuite: MegaProductivitySuite
url: "https://example.com/italia/medusa.git"
landingURL: "https://example.com/italia/medusa"
isBasedOn: "https://github.com/italia/otello.git"
isBasedOn:
- "https://github.com/italia/otello.git"
softwareVersion: "1.0"
releaseDate: "2017-04-15"
logo: img/logo.svg
Expand Down
7 changes: 5 additions & 2 deletions docs/standard/schema.core.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ download of such an installer.
Key ``isBasedOn``
~~~~~~~~~~~~~~~~~

- Type: string or array of strings
- Type: array of strings, or a single string (*deprecated*)
- Presence: optional
- Example: ``"https://github.com/italia/otello.git"``
- Example: ``["https://github.com/italia/otello.git"]``

In case this software is a variant or a fork of another software, which
might or might not contain a ``publiccode.yml`` file, this key will
Expand All @@ -94,6 +94,9 @@ 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.

The single string form is deprecated, use a one element array
instead.

Key ``softwareVersion``
~~~~~~~~~~~~~~~~~~~~~~~

Expand Down