Story (Required)

As a developer working on the AI software templates, there should be a PR check that tells me if all of dependencies in the software template (as pulled by ./generate.sh) have been updated. If generate.sh has not been run, the check should report an error status (but not block the PR from merging).

Background (Required)

In order to update certain dependencies in the AI software template, developers must run generate.sh to pull them from GitHub. Examples include the https://github.com/redhat-ai-dev/ai-lab-app repository (which contains the GitOps definitions), and the sample repositories in https://github.com/redhat-ai-dev/ai-lab-samples/.

Generally, developers will want to ensure that generate.sh has been run when pushing changes to the software templates, so a CI check that verifies if that's the case would be helpful. However, we do not want the check to block PR merges - as there are cases where we may not want to immediately update dependencies.

Out of scope

Approach (Required)

• Implement a GitHub actions workflow that runs generate.sh and checks git diff to see if anything changed
• If a diff is detected, the workflow should report an error
• The workflow should not be required to pass to merge.

Dependencies

<Describes what this story depends on. Dependent Stories and EPICs should be linked to the story.>

Acceptance Criteria (Required)

<Describe edge cases to consider when implementing the story and defining tests>

<Provides a required and minimum list of acceptance tests for this story. More is expected as the engineer implements this story>

documentation updates (design docs, release notes etc)
demo needed
SOP required
education module update (Filled by DEVHAS team only)
R&D label required (Filled by DEVHAS team only)

Done Checklist

Code is completed, reviewed, documented and checked in
Unit and integration test automation have been delivered and running cleanly in continuous integration/staging/canary environment
Continuous Delivery pipeline(s) is able to proceed with new code included
Customer facing documentation, API docs, design docs etc. are produced/updated, reviewed and published
Acceptance criteria are met
If the Grafana dashboard is updated, ensure the corresponding SOP is updated as well