Skip to content

[CI] Adding release notes for non-rc versions & PR validations workflows#289

Open
GiladShapira94 wants to merge 7 commits intomlrun:developmentfrom
GiladShapira94:ce-worfklows
Open

[CI] Adding release notes for non-rc versions & PR validations workflows#289
GiladShapira94 wants to merge 7 commits intomlrun:developmentfrom
GiladShapira94:ce-worfklows

Conversation

@GiladShapira94
Copy link
Copy Markdown
Collaborator

📝 Description

This PR adds the following:

  1. Release notes for non rc versions - add steps to release workflow
  2. Add PR title validation workflow

const title = context.payload.pull_request.title;
const prNumber = context.payload.pull_request.number;

const allowedScopes = ['feature', 'fix', 'docs', 'improvement', 'revert', 'breaking', 'ci'];
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The allowed scopes (feature, fix, docs, improvement, revert, breaking, ci) don't align with cliff.toml's commit parsers (feat, fix, perf, refactor, docs, chore, revert, breaking).

feature passes validation but won't match [feat] in cliff
improvement and ci pass validation but have no cliff parser at all
perf, refactor, chore are recognized by cliff but would fail validation
From what I understand, these two systems need to share the same vocabulary or the release notes categorization will be broken for newly enforced titles.

Comment thread .github/workflows/release.yml
Comment thread .github/workflows/pr-validation.yml Outdated
if (!match) {
core.setFailed(
`PR title must follow the format: [scope] description\n` +
`Example: [Feat] Add SeaweedFS bucket auto-creation\n` +
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example [Feat] Add SeaweedFS bucket auto-creation would fail this very validation. Feat lowercased is feat, which is not in allowedScopes (the list has feature, not feat). Either change the example to [Feature] ... or change the scope name to feat.

Comment thread .github/workflows/release.yml Outdated
| grep "^mlrun-ce-${VERSION}-rc." \
| head -1)
echo "tag=${FIRST_RC}" >> $GITHUB_OUTPUT
echo "First RC tag: ${FIRST_RC}"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if can happen, but If no RC tag exists for this version (e.g., a hotfix release that skipped RC), FIRST_RC will be empty. The downstream git-cliff step would then receive ^..HEAD as the range, which is invalid and will fail the workflow. you can add a guard if you think necessary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants