ci: pre-commit cff validation hook (#98)

Helmholtz-AI-Energy · Dec 18, 2023 · 5b6aab1 · 5b6aab1
1 parent d07d0a2
commit 5b6aab1
Show file tree

Hide file tree

Showing 2 changed files with 105 additions and 73 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,52 +1,58 @@
 repos:
-- repo: https://github.com/commitizen-tools/commitizen
-  rev: v3.13.0
-  hooks:
-  - id: commitizen
-    stages: [commit-msg]
-# - repo: https://github.com/python-poetry/poetry
-#   rev: '1.4.0' # add version here
-#   hooks:
-#     - id: poetry-check
-#     - id: poetry-lock
-#     - id: poetry-export
-#       args: ["-f", "requirements.txt", "-o", "requirements.txt"]
-- repo: https://github.com/pre-commit/mirrors-mypy
-  rev: v1.7.1  # Use the sha / tag you want to point at
-  hooks:
-  - id: mypy
-    additional_dependencies: [types-all]
-- repo: https://github.com/pycqa/pydocstyle
-  rev: 6.3.0  # pick a git hash / tag to point to
-  hooks:
-  - id: pydocstyle
-    additional_dependencies: [tomli]
-    files: ^perun/
-    args:
-    - --config=pyproject.toml
-- repo: https://github.com/asottile/seed-isort-config
-  rev: v2.2.0
-  hooks:
-  - id: seed-isort-config
-    args:
-    - --exclude=examples/
-- repo: https://github.com/pycqa/isort
-  rev: 5.13.1
-  hooks:
-    - id: isort
-      name: isort (python)
-- repo: https://github.com/psf/black
-  rev: 23.11.0
-  hooks:
-  - id: black
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.5.0
-  hooks:
-  - id: trailing-whitespace
-  - id: end-of-file-fixer
-  - id: check-yaml
-  - id: check-added-large-files
-- repo: https://github.com/PyCQA/flake8
-  rev: 6.1.0
-  hooks:
-  -   id: flake8
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v3.13.0
+    hooks:
+      - id: commitizen
+        stages: [commit-msg]
+  # - repo: https://github.com/python-poetry/poetry
+  #   rev: '1.4.0' # add version here
+  #   hooks:
+  #     - id: poetry-check
+  #     - id: poetry-lock
+  #     - id: poetry-export
+  #       args: ["-f", "requirements.txt", "-o", "requirements.txt"]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.7.1 # Use the sha / tag you want to point at
+    hooks:
+      - id: mypy
+        additional_dependencies: [types-all]
+  - repo: https://github.com/pycqa/pydocstyle
+    rev: 6.3.0 # pick a git hash / tag to point to
+    hooks:
+      - id: pydocstyle
+        additional_dependencies: [tomli]
+        files: ^perun/
+        args:
+          - --config=pyproject.toml
+  - repo: https://github.com/asottile/seed-isort-config
+    rev: v2.2.0
+    hooks:
+      - id: seed-isort-config
+        args:
+          - --exclude=examples/
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.1
+    hooks:
+      - id: isort
+        name: isort (python)
+  - repo: https://github.com/psf/black
+    rev: 23.11.0
+    hooks:
+      - id: black
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/PyCQA/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8
+  - repo: "https://github.com/citation-file-format/cffconvert"
+    rev: "054bda51dbe278b3e86f27c890e3f3ac877d616c"
+    hooks:
+      - id: "validate-cff"
+        args:
+          - "--verbose"
diff --git a/CITATION.cff b/CITATION.cff
@@ -1,29 +1,55 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
 cff-version: 1.2.0
-message: "If you use this software, please cite the paper."
+title: perun
+message: 'If you use this software, please cite the paper.'
+type: software
+authors:
+  - given-names: Juan Pedro
+    family-names: Gutiérrez Hermosillo Muriedas
+    email: [email protected]
+    affiliation: >-
+      Scientific Computing Centre, Karlsruhe Institute für
+      Technologie
+    orcid: 'https://orcid.org/0000-0001-8439-7145'
+repository-code: 'https://github.com/Helmholtz-AI-Energy/perun'
+repository: 'https://perun.readthedocs.io/en/latest/?badge=latest'
+keywords:
+  - Python
+  - Energy
+  - Benchmarking
+  - HPC
+  - MPI
+license: BSD-3-Clause
 preferred-citation:
   type: conference-paper
   authors:
-    - given-names: "Juan Pedro"
-      family-names: "Gutiérrez Hermosillo Muriedas"
-      email: "[email protected]"
-      affiliation: "Karlsruhe Institute für Technologie"
+    - given-names: Juan Pedro
+      family-names: Gutiérrez Hermosillo Muriedas
+      email: [email protected]
+      affiliation: Karlsruhe Institute für Technologie
       orcid: 'https://orcid.org/0000-0001-8439-7145'
-    - given-names: "Katharina"
-      family-names: "Flügel"
-    - given-names: "Charlotte"
-      family-names: "Debus"
-    - given-names: "Holger"
-      family-names: "Obermaier"
-    - given-names: "Achim"
-      family-names: "Streit"
-    - given-names: "Markus"
-      family-names: "Götz"
-  title: "perun: Benchmarking Energy Consumption of High-Performance Computing Applications"
+    - given-names: Katharina
+      family-names: Flügel
+    - given-names: Charlotte
+      family-names: Debus
+    - given-names: Holger
+      family-names: Obermaier
+    - given-names: Achim
+      family-names: Streit
+    - given-names: Markus
+      family-names: Götz
+  title: >-
+    perun: Benchmarking Energy Consumption of High-Performance Computing
+    Applications
   year: 2023
-  collection-title: "Euro-Par 2023: Parallel Processing"
-  collection-doi: "10.1007/978-3-031-39698-4"
-  doi: "10.1007/978-3-031-39698-4_2"
+  collection-title: 'Euro-Par 2023: Parallel Processing'
+  collection-doi: 10.1007/978-3-031-39698-4
+  doi: 10.1007/978-3-031-39698-4_2
   conference:
-    name: "29th International European Conference on Parallel and Distributed Computing"
-    date-start: 2023-08-28
-    date-end: 2017-09-01
+    name: >-
+      29th International European Conference on Parallel and Distributed
+      Computing
+    date-start: "2023-08-28"
+    date-end: "2017-09-01"