developer.overheid.nl

Ontwikkelaarsportaal van de Nederlandse overheid

Ga naar hoofdinhoud

REUSE

REUSE is een standaard waarmee je copyright en licenties in een softwareproject eenduidig vastlegt. Met deze standaard beschrijf je per map/ path welke licentie er van op toepassing is.

Je begint dus bij de root path, en definieert daarna de uitzonderingen:

./REUSE.toml
version = 1

[[annotations]]
path = "**"
SPDX-FileCopyrightText = "Developer.overheid.nl - Ministerie van Binnenlandse zaken"
SPDX-License-Identifier = "EUPL-1.2"

[[annotations]]
path = "src/fonts/ro/**"
SPDX-FileCopyrightText = "Rijksoverheid / Ministerie van Algemene Zaken"
SPDX-License-Identifier = "LicenseRef-RijksoverheidSans-proprietary"

[[annotations]]
path = "src/fonts/firasans/**"
SPDX-FileCopyrightText = "Copyright (c) 2012, Mozilla Foundation and Carrois Partners GbR"
SPDX-License-Identifier = "OFL-1.1"

[[annotations]]
path = "static/img/team/**"
SPDX-FileCopyrightText = "Ministerie van Binnenlandse Zaken / Respectievelijke rechtenhouders"
SPDX-License-Identifier = "LicenseRef-Beelden-proprietary"

[[annotations]]
path = "static/img/authors/**"
SPDX-FileCopyrightText = "Ministerie van Binnenlandse Zaken / Respectievelijke rechtenhouders"
SPDX-License-Identifier = "LicenseRef-Beelden-proprietary"

Waarom is dit belangrijk?​

Het LICENSE-bestand in de root van een project zegt vaak weinig over alle licenties die van toepassing zijn op het project als geheel. Vaak bevinden er zich nog fonts of images in het project waarop een heel andere licentie van toepassing is.

Tooling​

De FSFE onderhoudt de REUSE-tool, een CLI die je installeert met pipx install reuse.

De belangrijkste commando's:

reuse lint # controleer of het project aan REUSE voldoet
reuse download --all # zet ontbrekende licentieteksten in LICENSES/
reuse spdx > sbom.spdx # genereer een SPDX Software Bill of Materials

CI/CD​

Met een job in je CI/CD-pipeline draai je reuse lint bij elke pull request, zodat een bestand zonder licentie niet ongemerkt in main belandt.

Gebruik hiervoor de REUSE GitHub Action.

.github/workflows/reuse.yml
name: REUSE
on:
pull_request:
workflow_dispatch:
jobs:
reuse-lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: fsfe/reuse-action@v5