config.yml 1.49 KB
Newer Older
Maximilian Dolling's avatar
Maximilian Dolling committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)
#
# SPDX-License-Identifier: CC0-1.0

# OPTIONAL, to determine for which files the license header should be with the file
comment in file:
  - '<PYTHON REGEX>'
# MANDATORY, to add a description of the whole software to the header
description: '<STRING>'
# OPTIONAL, to skip over files for applying the license header
#           usually the things in .gitignore
ignore paths:
  - '<PYTHON REGEX>'
# MANDATORY, to set scopes for multiple licenses in a project
licenses:
  # MANDATORY, all files, that do not go into another scope, go here
  default:
    # MANDATORY, the copyright holder of the file that the header is applied to,
    #            additionally it is used for the entry in the README.md
    copyright: '<STRING>'
    # MANDATORY, unique identifier used for licenses
    spdx-identifier: '<SPDX IDENTIFIER, see https://spdx.org/licenses/>'
  # OPTIONAL, as many scopes as you wish are possible
  #           their names must be unique
  #           the license of the first scope that matches (determined by 'files' below) will be applied
  <SCOPE NAME>:
    # MANDATORY, the copyright holder of the file that the header is applied to
    copyright: '<STRING>'
    # MANDATORY, unique identifier used for licenses
    spdx-identifier: '<SPDX IDENTIFIER, see https://spdx.org/licenses/>'
    # MANDATORY: regex to match to apply this scope
    files:
      - '<PYTHON REGEX>'