#45: Add reusable workflows

[ddundo]

Closes #45.

After this is merged I will change citation_check.yml in Animate/Goalie/Movement to be:

name: 'Citation Check'

on:
  push:
    branches:
      - main
    paths:
      - '**/*.cff'

  pull_request:
    paths:
      - '**/*.cff'

  workflow_dispatch:

jobs:
  citation_check:
    uses: mesh-adaptation/mesh-adaptation-docs/.github/workflows/citation_check.yml@main

and test_suite.yml in Animate will be:

name: 'Run Animate Test Suite'

on:
  push:
    branches:
      - main
  pull_request:
  schedule:
    - cron: '0 1 * * 0'

jobs:
  test_suite:
    uses: mesh-adaptation/mesh-adaptation-docs/.github/workflows/test_suite.yml@main
    with:
      install-command: 'python -m pip uninstall -y animate && python -m pip install -e .'
      test-command: |
        export GITHUB_ACTIONS_TEST_RUN=1
        python $(which firedrake-clean)
        export ANIMATE_CHECKPOINT_DIR=$(pwd)/.checkpoints
        python -m coverage erase
        python -m coverage run --source=animate -m pytest -v --durations=20 test
        python -m coverage report
      changed-files-patterns: |
        **/*.py
        **/*.cxx

and similarly for Goalie and Movement.

[jwallwork23]

This is cool, thanks @ddundo. Just one minor suggestion.

[ddundo]

@jwallwork23 maybe I could also remove

check_citation:
	@echo "Checking CITATION.cff formatting..."
	@cffconvert --validate
	@echo "PASS"

from the Makefiles and add it centrally to reusable_citation_check.yml?

[jwallwork23]

@jwallwork23 maybe I could also remove

check_citation:
	@echo "Checking CITATION.cff formatting..."
	@cffconvert --validate
	@echo "PASS"

from the Makefiles and add it centrally to reusable_citation_check.yml?

I'd prefer to keep it in so that users and developers can run locally.

[jwallwork23]

@jwallwork23 maybe I could also remove

check_citation:
	@echo "Checking CITATION.cff formatting..."
	@cffconvert --validate
	@echo "PASS"

from the Makefiles and add it centrally to reusable_citation_check.yml?

Actually, you're right - it's probably not necessary for this to be duplicated across all the repos. The citation isn't going to change that often either. Let's remove it from the Makefile.

[ddundo]

Great, thanks! I made these changes and tested it on Animate mesh-adaptation/animate#148 so I'll merge :)