Commit 8cbbf7b8 authored by Maximilian Dolling's avatar Maximilian Dolling
Browse files

filled config

parent 1646a640
Pipeline #11919 passed with stage
in 41 seconds
# 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
- '.*.py$'
- '.*.yml$'
- '.*.toml$'
- '.*.md$'
- '.*.txt$'
- '.*.gitignore$'
- '.*pylintrc$'
description: 'Showcase Repository for Software-Quality-Assurance'
ignore paths:
- '<PYTHON REGEX>'
# MANDATORY, to set scopes for multiple licenses in a project
# git
- '.*.git/.*'
# IDE's
- '.*.idea/.*'
# env
- '.*venv/.*'
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
copyright: 'Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)'
spdx-identifier: 'GPL-3.0-or-later'
Insignificant:
copyright: 'Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)'
spdx-identifier: 'CC0-1.0'
files:
- '<PYTHON REGEX>'
- '.*.txt$'
- '.*.md$'
- '.*.yml$'
- '.*pylintrc$'
- '.*jinja2$'
Software:
copyright: 'Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)'
spdx-identifier: 'GPL-3.0-or-later'
files:
# Python
- '.*.py$'
Data:
copyright: 'Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)'
spdx-identifier: 'CC-BY-4.0'
files:
- '.*.json$'
software-quality-assurance
This Software provides services to check and improve the source code quality of software-projects
[<SOFTWARE NAME>]
[<SOFTWARE DESCRIPTION>]
SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)
{% for copyright_line in copyright_lines %}
{{ copyright_line }}
{% endfor %}
SPDX-License-Identifier: GPL-3.0-or-later
{% for expression in spdx_expressions %}
SPDX-License-Identifier: {{ expression }}
{% endfor %}
Parts of this program <(especially the code for whatever)>
were developed within the context of the following publicly funded
......
[<SOFTWARE NAME>]
[<SOFTWARE DESCRIPTION>]
{% for copyright_line in copyright_lines %}
{{ copyright_line }}
{% endfor %}
......
<!--
SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)
SPDX-License-Identifier: CC0-1.0
-->
## License
Copyright © [<YEAR>] [<COPYRIGHT>]
......
# software-quality-assurance
# This Software provides services to check and improve the source code quality of software-projects
#
# SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# Parts of this program <(especially the code for whatever)>
# were developed within the context of the following publicly funded
# projects or measures:
# - Helmholtz Federated IT Services, Helmholtz Association of German Research Centres (https://software.hifis.net/)
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, Version 3 or later.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You can find a copy of the license in the LICENSES folder.
# If not, see <http://www.gnu.org/licenses/>.
title = "gitleaks config"
[[rules]]
description = "AWS Manager ID"
......
# SPDX-FileCopyrightText: 2020 Helmholtz Centre Potsdam - GFZ German Research Centre for Geosciences, Germany (https://www.gfz-potsdam.de/)
#
# SPDX-License-Identifier: CC0-1.0
# META
# valid names for programming languages
# ['Python',
# 'Ruby',
# 'Shell',
# 'Dockerfile',
# 'Java',
# 'HTML',
# 'C',
# 'PHP',
# 'Batchfile',
# 'JavaScript']
# OPTIONAL, files, paths to exclude from analyzing licenses
# non-programming language files should go here
exclude:
- '<PYTHON REGEX>'
manual dependency config:
# MANDATORY, the name of the programming language the library is used in
<NAME OF PROGRAMMING LANGUAGE>:
# MANDATORY, sometimes the name to import differs from the name to download via a pkg-manager
# therefore the matching can be done here, if it cannot be resolved by a pkg manager
- import name: '<IMPORT NAME>'
pkg name: '<DOWNLOAD NAME>'
# OPTIONAL, if the dependency is a local import (part of your software) you should ignore it,
# because is has no license
ignore: '<BOOLEAN>'
# OPTIONAL, it is possible to use two different versions of a dependency - you can set the version here
version: '<VERSION STRING>'
# OPTIONAL, it is common, that the pkg repositories do not know the license(s) for a package
# you can give assign it here
licenses:
- '<SPDX-IDENTIFIER>'
# git
- '.*.git/.*'
# IDE's
- '.*.idea/.*'
# env
- '.*venv/.*'
# tests
- 'test/.*'
# data
- 'data/.*'
# non source files
- '.*.md$'
- '.*.txt$'
- '.*.sqa/.*'
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment