diff --git a/.github/workflows/citation.yml b/.github/workflows/citation.yml new file mode 100644 index 0000000..54eee2e --- /dev/null +++ b/.github/workflows/citation.yml @@ -0,0 +1,36 @@ +name: Validate CITATION.cff + +on: + push: + branches: + - main + pull_request: + branches: + - main + types: [opened, reopened, edited, synchronize] + +jobs: + build: + name: Validate CITATION.cff + runs-on: ubuntu-latest + + steps: + + - name: Skip Duplicate Actions + uses: fkirc/skip-duplicate-actions@v5 + + - uses: actions/checkout@v3 + + - name: Set up Python 3.8 + uses: actions/setup-python@v4 + with: + python-version: 3.8 + + - name: Install cffconvert + run: | + pip3 install --user cffconvert + cffconvert --version + + - name: Validate schema + run: | + cffconvert --validate -i CITATION.cff diff --git a/.github/workflows/demo.yaml b/.github/workflows/demo.yaml index d35029b..293f0d7 100644 --- a/.github/workflows/demo.yaml +++ b/.github/workflows/demo.yaml @@ -36,7 +36,7 @@ jobs: - name: Install Python dependencies run: | - pip3 install --user ${{ matrix.python-inplace }} . + pip3 install --user ${{ matrix.inplace }} . - name: Run demo run: | diff --git a/CITATION.cff b/CITATION.cff index 0970373..7032e81 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -3,6 +3,12 @@ cff-version: 1.2.0 title: ConFlowGen +abstract: A generator for synthetic container flows at maritime container terminals with a focus on yard operations +contact: + - affiliation: "Institute of Maritime Logistics, Hamburg University of Technology (TUHH)" + email: marvin.kastner@tuhh.de + family-names: Kastner + given-names: Marvin message: >- Please cite this software using the metadata from 'preferred-citation'. @@ -47,7 +53,7 @@ preferred-citation: country: DE date-start: 2022-02-23 date-end: 2022-02-25 - editors-series: + editors: - family-names: Freitag given-names: Michael - family-names: Kinra diff --git a/Readme.md b/Readme.md index 3f00dee..95dc8f2 100644 --- a/Readme.md +++ b/Readme.md @@ -1,5 +1,6 @@ [![Documentation Status](https://readthedocs.org/projects/conflowgen/badge/?version=latest)](https://conflowgen.readthedocs.io/en/latest/?badge=latest) -[![Docs](https://github.com/1kastner/conflowgen/actions/workflows/docs.yaml/badge.svg)](https://github.com/1kastner/conflowgen/actions/workflows/docs.yaml) +[![documentation built](https://github.com/1kastner/conflowgen/actions/workflows/docs.yaml/badge.svg)](https://github.com/1kastner/conflowgen/actions/workflows/docs.yaml) +[![CITATION.cff valid](https://github.com/1kastner/conflowgen/actions/workflows/citation.yml/badge.svg)](https://github.com/1kastner/conflowgen/actions/workflows/citation.yml) [![Tests](https://github.com/1kastner/conflowgen/actions/workflows/unittests.yaml/badge.svg)](https://github.com/1kastner/conflowgen/actions/workflows/unittests.yaml) [![codecov](https://codecov.io/gh/1kastner/conflowgen/branch/main/graph/badge.svg?token=GICVMYHJ42)](https://codecov.io/gh/1kastner/conflowgen)