BigSamu / OpenSearch_Changelog_Workflow

A reusable workflow for automating changelog and release notes generation processes for OpenSearch repos
Apache License 2.0
0 stars 4 forks source link

Add check to workflow to make sure changeset file is properly formatted #40

Open JohnathonBowers opened 7 months ago

JohnathonBowers commented 7 months ago

The workflow needs to check to make sure that a properly-formatted changeset file is among the commits on the forked branch that a PR is coming from.

Notes from Ashwin on expected outcomes:

The scenario i want to guard against are these 2:

  1. if the PR author manually adds a changeset file in the PR without a changelog entry in the PR description. Expected outcome: if its a valid file - pass the workflow, if its incorrect fail the workflow with the error
  2. if the author does not have the app installed, adds changelog entries to the PR description and is told to add the file manually or install the app. They then decide to do it manually. expected outcome: if vaild changeset file - pass the workflow, else fail with error and label
BigSamu commented 3 months ago

@ashwin-pc,

@msheldon32 want to takes this issue. It is the 2nd part of the implementation of the manual approach feature. Matt any question, please let me know.

ashwin-pc commented 2 months ago

That would be amazing! Any updates on this?