♻️ Refactor the Malformed YAML Shared GitHub Action

[jasonBirchall]

User Need

As an administrator of the GitHub-actions shared repository,
I want to rewrite the malformed-yaml action in Python
so that I can fix the current bug with the image type and ensure the action is maintainable by the Operations Engineering team going forward.

Value

Rewriting the malformed-yaml action in Python will address the immediate issue of the image type bug and, more importantly, transform the action into a language that our team is more comfortable with. This transition will facilitate easier maintenance, faster updates, and the ability to address future bugs or add new features quickly.

• Connected to Bug: Malformed Yaml: dependency error @main github-actions#230

Functional Requirements:

• Analyse the existing Ruby implementation of the malformed-yaml action to understand its functionality and the bug's nature.
• Redesign the architecture of the action for Python, ensuring it provides the same functionality.
• Develop a comprehensive test suite for the Python version of the action to ensure it meets all operational requirements without regressions.

Non-Functional Requirements:

• The action must be fully compatible with existing workflows that previously relied on the Ruby version, ensuring a seamless transition.
• If breaking changes are required then the new action should be in a new release and comms made to alert people they can upgrade to use it and what changes they may need to make.
• Documentation must be thoroughly updated to reflect the change in language and any new procedures for using the action.

Acceptance Criteria:

• The new Python version of the malformed-yaml action is fully functional and resolves the image type bug.
• Automated tests confirm that all functionalities work as expected without introducing new issues.
• New release and comms with details on any changes required to workflows.
• The Python version of the action is reviewed and approved by at least one other team member.

Notes:

The decision to transition the malformed-yaml action to Python stems from our team's expertise in this language and the challenges we've faced maintaining the Ruby version. This rewrite is not just a bug fix but a strategic move to align the action with our team's skills and future-proofing our infrastructure.

[tamsinforbes]

Dual testing in test repo to compare output from Ruby 💎 version and new 🐍 Python version.

Using task branch mal-yaml-to-python in ministryofjutstice/github-actions repo

Refs

https://jacobtomlinson.dev/posts/2019/creating-github-actions-in-python/
https://github.com/jacobtomlinson/python-container-action

The above examples are adapted from GitHub's https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action

To do

• create a dual action python-malformed-yaml alongside malformed-yaml to check they both perform the same functionality and require no changes by the user.
• dockerfile - what docker image?
• tests
• workflow to run tests, including different kinds of bad yaml files
• update readme for python-malformed-yaml on github-actions
• fix so action fails if there are any malformed yamls - and prints out filename and exception
• malformed-yaml action name is not pythonic (- vs _) can't import function for tests 🙄 fix
• leave a change request to fix the malformed yaml files under the PR conversation tab
• delete malformed-yaml action and rename python-malformed-action to malformed-action
• create new release

[tamsinforbes]

ministryofjustice/github-actions#255