DCMAW-12245: github action versioning spike

[kikidawson-gds]

Jira Ticket

DCMAW-12245

Description of changes

Summary of Spike

• post-merge workflow created that's triggered when updates to anything in workflows labelled job_ gets updated
• workflow runs validation on name to ensure name matches with file name and checks it doesn't contain whitespaces or other characters
• workflow runs validation on version to ensure it's been updated correctly and prints whether it's a major minor or patch update
• workflow creates and pushes tag with name in this style --> ci-checks/v1.0.0. Then creates a release with the release note as the message in the description of job workflow
• pull-request workflow is similar to the post-merge but doesn't create tag or release
• The workflows run on the assumption that an initial tag already exists. Workflow created designed to be run manually to create an initial tag called new-job-name/v0.0.1
• Idea is still to house these jobs in their own repo
• jobs can be pinned to SHA

TODO

• Test if dependabot can update

Review guidance

Review checklist

Functional Review

• Functionality: Does it meet the acceptance criteria on the ticket and work as expected?
• Requirements: Does the code meet functional and non-functional requirements including compliance with programme standards and security gates?

Security & Compliance

• Personally Identifiable Information: Is it possible for PII to be logged?
• Security Considerations: Are there any security implications that need to be addressed?

Quality Assurance

• Testing: Is the code well-tested with sufficient coverage to provide confidence in correctness?
• Edge Cases: Have edge cases been considered and handled appropriately?

Code Quality

• Readability: Is the code easy to understand for all team members, with clear naming and appropriate documentation?
• Maintainability: Is the code easy to change, reuse, and extend?
• Code Style: Does it follow our coding conventions and best practices?
• Code Quality: Is the code maintainable and following best practices? See Values, Principles & Practices

Observability & Operations

• Observability: Are there appropriate logs/metrics that would help debug and monitor the service?
• Performance: Are there any performance considerations or potential bottlenecks?
• Runbooks for Alarms: If an alarm has been created or updated, has a corresponding runbook been created or updated?
  • Critical alarms runbook
  • Warning alarms runbook

Documentation

• Documentation: Is the code well documented? Is there any existing documentation that needs updating?
• Comments: Are complex sections of code adequately commented if the intent is not clear?

Review PR:

• Title: Contains ticket number and clear summary of change
• Description: Has clear description of change

Evidence

Documentation