Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

style: check pr title with commitlint #853

Merged
merged 2 commits into from
Oct 16, 2024
Merged

Conversation

andysim3d
Copy link
Collaborator

@andysim3d andysim3d commented Oct 15, 2024

[Closes/Fixes] #

Proposed Changes

test pr title check.

@andysim3d andysim3d changed the title style: check pr title with commitlint. Andy/random test Oct 15, 2024
@andysim3d andysim3d force-pushed the andy/fix-pr-commit-lint branch 3 times, most recently from d33b00b to 36ed850 Compare October 15, 2024 17:47
@andysim3d andysim3d changed the title Andy/random test Andy/random test pr-check Oct 15, 2024
@andysim3d andysim3d force-pushed the andy/fix-pr-commit-lint branch from 36ed850 to c97df67 Compare October 15, 2024 17:50
@andysim3d andysim3d changed the title Andy/random test pr-check Andy/random test pr-check. Oct 15, 2024
@andysim3d andysim3d changed the title Andy/random test pr-check. Andy/random test pr-check title Oct 15, 2024
@andysim3d andysim3d closed this Oct 15, 2024
@andysim3d andysim3d reopened this Oct 15, 2024
@andysim3d andysim3d force-pushed the andy/fix-pr-commit-lint branch from c97df67 to d3ec505 Compare October 15, 2024 17:56
@andysim3d andysim3d changed the title Andy/random test pr-check title Andy/random test pr-check title test. Oct 15, 2024
@andysim3d andysim3d changed the title Andy/random test pr-check title test. style: check pr title with commitlint Oct 15, 2024
Comment on lines 14 to 16
- uses: amannn/action-semantic-pull-request@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should we just do this ourselves? So that we can make sure its the check that runs against the commits? Similar to how its done in AA-SDK.

Copy link
Collaborator Author

@andysim3d andysim3d Oct 15, 2024

Choose a reason for hiding this comment

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

you mean check-in a binary/tool to run the semantic lint check?

I find this one on action marketplace and thinking 3 benefits of using it:

  • the github action get updates if in the future semantic pull request extended.
  • the binary checks commits semantic is not related to our main logic. we use cocogitto/cocogitto-action@v3 to check it.
  • this repo is open sourced, granting read access of github action is low risk.

I have no objections to use our own tool to check semantic commit/pr title and merge 2 checks in one to keep the check consistent.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Got it. My concern here would be if action-semantic-pull-request and cocogitto-action diverge in their enforcement of conventional commits then we could get commits in that are invalid to cocogitto-action and thus cause downstream PRs to fail CI.

If we don't think thats a problem at the moment, we can just address it if it becomes one.

@andysim3d andysim3d force-pushed the andy/fix-pr-commit-lint branch from d3ec505 to 4d1ce42 Compare October 15, 2024 18:42
@andysim3d andysim3d requested a review from dancoombs October 15, 2024 19:03
@dancoombs
Copy link
Collaborator

Should we sync our config with the one from the action github?

https://github.com/amannn/action-semantic-pull-request?tab=readme-ov-file#installation

@andysim3d
Copy link
Collaborator Author

Should we sync our config with the one from the action github?

https://github.com/amannn/action-semantic-pull-request?tab=readme-ov-file#installation

the example is based on multi-forks repo. we use multi-branch so the trigger and read permission are slightly different.

@andysim3d andysim3d force-pushed the andy/fix-pr-commit-lint branch from 4d1ce42 to e25b5bf Compare October 16, 2024 01:08
@dancoombs dancoombs merged commit e0fe4e1 into feat/v0.4 Oct 16, 2024
8 checks passed
@dancoombs dancoombs deleted the andy/fix-pr-commit-lint branch October 16, 2024 15:15
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