Skip to content

Commit f50d42e

Browse files
authored
Move citation.cff validation to pre-commit check (#165)
* move citation.cff validation to pre-commit check * remove cffconvert from dev deps * update docs * update lockfile * update lockfile with new changes
1 parent 4f4b6da commit f50d42e

File tree

5 files changed

+7
-133
lines changed

5 files changed

+7
-133
lines changed

.github/workflows/test.yml

-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,5 @@ jobs:
3333
run: poetry install --no-interaction --no-ansi
3434
- name: Run sphinx-docs build test
3535
run: poetry run sphinx-build docs/source doctest -W
36-
- name: Run citation file test
37-
run: poetry run cffconvert --validate
3836
- name: Run pytest
3937
run: poetry run pytest

.pre-commit-config.yaml

+4
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@ repos:
6262
rev: v1.8.0
6363
hooks:
6464
- id: mypy
65+
- repo: https://github.com/citation-file-format/cffconvert
66+
rev: 5295f87c0e261da61a7b919fc754e3a77edd98a7
67+
hooks:
68+
- id: validate-cff
6569
- repo: https://github.com/PyCQA/pylint
6670
rev: v3.0.3
6771
hooks:

docs/source/contributing.md

-1
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,6 @@ Automated testing is performed using [GitHub Actions](https://docs.github.com/en
137137
Example test command: `% poetry run pytest`
138138
1. [sphinx-build](https://www.sphinx-doc.org/en/master/man/sphinx-build.html) provides documentation website build checks via [`-W`](https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-W) (which turns warnings into errors).
139139
Example command: `% poetry run sphinx-build docs/source docs/build -W`
140-
1. [cffconvert](https://github.com/citation-file-format/cffconvert) provides [CITATION.cff file](https://citation-file-format.github.io/) formatting checks. Example command: `% poetry run cffconvert --validate`
141140
1. [pre-commit](https://pre-commit.com/) provides various checks which are treated as failures in automated testing.
142141
Example command `% pre-commit run -all-files`
143142

poetry.lock

+3-129
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ Sphinx = "^6.0.0"
3636
myst-parser = "^2.0.0"
3737
sphinxcontrib-mermaid = "^0.9.0"
3838
moto = {extras = ["s3", "server"], version = "^4.0.0"}
39-
cffconvert = "^2.0.0"
4039
cytominer-database = "^0.3.4"
4140
pycytominer = "^1.1.0"
4241
dunamai = "^1.19.0"

0 commit comments

Comments
 (0)