cci-moc/ansible-switches-auto-deploy

Automated deployment of MOC/OCT switches on commit to ansible-switches repo

ansible-switches-auto-deploy's Issues

Restructure repository

It would be nice to restructure this repository to have a more conventional project layout. That might look something like:

.
├── Containerfile
├── README.md
├── requirements.txt
├── slack_notifier
│   ├── __init__.py
│   ├── github.py
│   ├── notifier.py
│   └── slack.py
├── test-requirements.txt
└── tests
    ├── test_github.py
    ├── test_notifier.py
    └── test_slack.py

Along with the reorganization we should add a pyproject.toml so that the project can be installed using pip install.

Add github workflow to run unit tests

This project includes a small test suite. We should add a github workflow that will run the included tests for any pull requests.

Add github workflow to build and publish container image

We will ultimately be deploying this project in OpenShift, which means we'll need a source for an appropriate container image.

Add a GitHub workflow to the project that will build and publish a new container image whenever a commit merges to the main branch. Consider also adopting a versioning strategy (e.g., semantic versioning) and tagging images appropriately when there is a new release.

Once this workflow is in place we can reference the published image in the kubernetes manifests.

Add github workflow to perform basic linting

"Linting" is the process of analyzing code for syntax errors, formatting issues, and other minor problems. We should add a github workflow that will perform these simple tests for any pull requests.

We typically use pre-commit to manage this sort of process. A typical configuration would include something like flake8 for linting and black for formatting, although recently there has been a lot of excitement around ruff, which can do both.

As part of implementing this feature, you will want to arrange to run these tools automatically in your local repository before creating a pull request (ideally, before every commit); this helps avoid a variety of problems.