patternfly / patternfly/patternfly-react

Investigate CI solution for ensuring proper commit format for the first commit of PRs

Open
#10,755 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

PF Team Stale
Dominant language
TypeScript
Stars
862
Forks
392
Avg merge
4d 8h
Merged PRs (30d)
9

Description

Describe the enhancement or change
We pretty often run into issues where improper commit message formatting causes a release to not happen when expected.

This could be resolved by enforcing formatting on every commit like we do in core, but that would be a bit of an inconvenience for all but the first commit since we squash on merge and the commit message format after the first commit doesn't matter.

We may be able to use https://github.com/wagoid/commitlint-github-action or something similar to do this.

Also, if we do find a good solution here we should probably replicate it in the extension repos.


Jira Issue: PF-44

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by reviewing the repository's CI setup and evaluating commitlint-github-action or a similar approach for checking only the first commit of a pull request. Done means documenting or implementing a workable check that preserves squash-merge behavior and deciding whether it can be replicated in the extension repositories.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.