Skip to content

Commit

Permalink
📝 Move ISO/IEC 5230/OpenChain to licenses
Browse files Browse the repository at this point in the history
  • Loading branch information
veit committed May 19, 2023
1 parent 8e01480 commit 93e487e
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 33 deletions.
42 changes: 30 additions & 12 deletions docs/productive/licensing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -253,15 +253,18 @@ add to the header of your licence files:
#
# SPDX-License-Identifier: [identifier]
.. _check_conformity:

Check conformity
----------------

`REUSE <https://reuse.software/>`_ was initiated by the Free Software Foundation
Europe (FSFE) to facilitate the licensing of free software projects. The `REUSE
tool <https://git.fsfe.org/reuse/tool>`_ checks licenses and supports you in
compliance with the license. With the `REUSE API
.. _reuse:

REUSE
~~~~~

`REUSE <https://reuse.software/>`__ was initiated by the Free Software
Foundation Europe (FSFE) to facilitate the licensing of free software projects.
The `REUSE tool <https://git.fsfe.org/reuse/tool>`_ checks licenses and supports
you in compliance with the license. With the `REUSE API
<https://reuse.software/dev/#api>`_ you can also generate a dynamic compliance
badge:

Expand All @@ -271,7 +274,7 @@ badge:
.. _gitlab-ci-workflow:

CI workflow
~~~~~~~~~~~
:::::::::::

You can easily integrate REUSE into your continuous integration workflow, for
example for GitLab in the ``.gitlab-ci.yml`` file with:
Expand All @@ -286,7 +289,26 @@ example for GitLab in the ``.gitlab-ci.yml`` file with:
- reuse lint
Alternatives
~~~~~~~~~~~~
::::::::::::

.. _open_chain:

`ISO/IEC 5230/OpenChain <https://de.wikipedia.org/wiki/ISO/IEC_5230>`_
recommends :ref:`REUSE <reuse>` as a component to improve license and
copyright clarity, but sets higher requirements to achieve full compliance.

It is based on `OpenChain Specification 2.1
<https://github.com/OpenChain-Project/License-Compliance-Specification/raw/master/2.1/de/OpenChain-2.1_original_de.pdf>`_
and is an international standard on software supply chains, simplified
procurement, and open source license compliance.

.. seealso::

* `OpenChain project <https://www.openchainproject.org>`_
* `OpenChain Self Certification
<https://certification.openchainproject.org>`_
* `Reference-Material
<https://github.com/OpenChain-Project/Reference-Material>`_

`ScanCode <https://www.aboutcode.org/projects/scancode.html>`_
offers a range of tools and applications for scanning software codebases and
Expand All @@ -299,10 +321,6 @@ Alternatives
`ClearlyDefined <https://clearlydefined.io/>`_
collects and displays information about the licensing and copyright
situation of a software project.
:ref:`open_chain`
recommends REUSE as a component to improve the clarity of the licensing and
copyright situation, but has more stringent requirements to achieve full
compliance.
`FOSSology <https://www.fossology.org/>`_
is a free software compliance toolkit that stores information in a database
with license, copyright, and export scanners.
Expand Down
23 changes: 2 additions & 21 deletions docs/productive/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,8 @@ OSSF-Scorecard uses the `GitHub License API
for projects hosted on GitHub, otherwise it uses its own heuristics to detect a
published license file. Files in a :file:`LICENSES` directory should be named
with their :ref:`SPDX <standard_format_licensing>` licence identifier followed
by an appropriate file extension as described in the :ref:`REUSE
<check_conformity>` specification.
by an appropriate file extension as described in the :ref:`REUSE <reuse>`
specification.

Are the best practices of the :abbr:`CII (Core Infrastructure Initiative)` being followed?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -268,22 +268,3 @@ reduce this risk by
* automated tools that notify you when dependencies in your project are out of
date
* update applications that lock dependencies quickly.

.. _open_chain:

ISO/IEC 5230/OpenChain
----------------------

`ISO/IEC 5230 <https://en.wikipedia.org/wiki/ISO/IEC_5230>`_ is based on the
`OpenChain Specification 2.1
<https://github.com/OpenChain-Project/License-Compliance-Specification/raw/master/2.1/de/OpenChain-2.1_original_de.pdf>`_ and is an international standard on
software supply chains, simplified procurement and open source licence
compliance.

.. seealso::

* `OpenChain project <https://www.openchainproject.org>`_
* `OpenChain Self Certification
<https://certification.openchainproject.org>`_
* `Reference-Material
<https://github.com/OpenChain-Project/Reference-Material>`_

0 comments on commit 93e487e

Please sign in to comment.