How to share domain code between GitHub Actions

[josecelano]

We have been building a proof of concept with some GitHub Actions. Right now every action is totally decoupled from the rest. We are going to need a way to share domain login between actions.

We already have an example. We have a duplicate code for parsing the image filename. We need to parse the filename in the validate-filename action and also in the validate-gold-image-folder action.

validate-filename: https://github.com/Nautilus-Cyberneering/chinese-ideographs/blob/main/.github/actions/validate-filenames/src/validation/validate_filenames.py#L62-L67:

validate-gold-image-folder:
https://github.com/Nautilus-Cyberneering/chinese-ideographs/pull/63/files#diff-23d71a228dcc178c2a592fc013ea7d194c7b4156df02ce237b90ce4453b52003R6-R11

We have already been discussing some solutions:

1. "Repo level code": we can add a source folder with Python modules that could be called directly on the workflow. This option could be valid for data manipulation, usually a step in the middle of other steps.
2. "Domain app action": we could create an action for the domain logic. We could use action composition but we could not use it inside of another action.
3. "Python package": we can create a domain package that can be installed in the GitHub Actions like a standard Python package. This option makes things more complicated for development.
4. "Dynamically loading of domain package/app": the domain app/package could be loaded into the GitHub Action using git (on PRODUCTION) and maybe mounting a docker volume (on development)
5. "One monolithic action": we have a repo with a console app with all the logic. And we create a GitHub ACtion wrapper for the app. On the workflow, we always call the same action with different arguments. This option could make sense for specific actions that are not reusable in other projects. validate-filenames and validate-gold-image-folder could be that type of actions. dvc-diff and resize-image seem to be more generic.

Current code structure:

.
├── contrib
│   └── github-merge
│       ├── github-merge.py
│       └── README.md
├── CONTRIBUTING.md
├── data
│   ├── 000001
│   │   └── 32
│   │       ├── 000001-32.600.2.tif
│   │       ├── 000001-32.600.2.tif.dvc
│   │       └── .gitignore
│   └── 000002
│       └── 32
│           ├── 000002-32.600.2.tif
│           ├── 000002-32.600.2.tif.dvc
│           └── .gitignore
├── documentation
│   ├── Contributor_Code_of_Conduct.md
│   ├── Filenames_and_Folder_Structure_Conventions.md
│   ├── File_Naming_Convention.md
│   ├── Gold_Images.md
│   └── Governance.md
├── .dvcignore
├── .env.ci
├── .github
│   ├── actions
│   │   ├── dvc-diff
│   │   │   ├── action.yml
│   │   │   ├── Dockerfile
│   │   │   ├── entrypoint.sh
│   │   │   └── README.md
│   │   ├── resize-image
│   │   │   ├── action.yml
│   │   │   ├── Dockerfile
│   │   │   ├── README.md
│   │   │   └── src
│   │   │       ├── main.py
│   │   │       └── resizing
│   │   │           └── resize.py
│   │   ├── validate-filenames
│   │   │   ├── action.yml
│   │   │   ├── Dockerfile
│   │   │   ├── .gitignore
│   │   │   ├── README.md
│   │   │   └── src
│   │   │       ├── main.py
│   │   │       ├── test
│   │   │       │   ├── __init__.py
│   │   │       │   └── validation
│   │   │       │       ├── __init__.py
│   │   │       │       └── test_validate_filenames.py
│   │   │       └── validation
│   │   │           ├── __init__.py
│   │   │           └── validate_filenames.py
│   │   └── validate-gold-image-folder
│   │       └── src
│   │           ├── test
│   │           │   └── validation
│   │           └── validation
│   └── workflows
│       ├── gold-drawings-processing.yml
│       └── resize-image-with-action.yml
├── .gitignore
├── README.md
└── src