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.

Sign up for GitHub

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

Jump to bottom

ci: add a workflow that enforces PR titles follow the conventional commit spec #2390

Closed
lucasrod16 opened this issue Mar 20, 2024 · 0 comments · Fixed by #2391
Closed

ci: add a workflow that enforces PR titles follow the conventional commit spec #2390

lucasrod16 opened this issue Mar 20, 2024 · 0 comments · Fixed by #2391
Assignees
@lucasrod16
Labels
tech-debt 💳 Debt that the team has charged and needs to repay

Comments

@lucasrod16
Copy link
Member

lucasrod16 commented Mar 20, 2024 •
edited

Describe what should be investigated or refactored

A workflow should be added to our existing CI to enforce PR titles follow the conventional commits spec

Since we squash all commits in a PR on merge, only the PR title is relevant since that becomes the single commit message when a PR is merged.

The contributing guide should also be updated to reflect this convention.

Links to any relevant code

`https://github.com/defenseunicorns/zarf/tree/main/.github/workflows

Additional context

Should follow this same general pattern:
https://github.com/defenseunicorns/kubernetes-fluent-client/blob/main/.github/workflows/commitlint.yml
@lucasrod16 lucasrod16 added the tech-debt 💳 Debt that the team has charged and needs to repay label Mar 20, 2024
@lucasrod16 lucasrod16 self-assigned this Mar 20, 2024
@lucasrod16 lucasrod16 mentioned this issue Mar 20, 2024
Merged
5 tasks
Noxsios added a commit that referenced this issue Mar 21, 2024
@lucasrod16 @Noxsios
ci: add commitlint workflow and update contributing guide (#2391)
329a1ae 
## Description
add commitlint workflow and update contributing guide

## Related Issue

Fixes #2390

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Other (security config, docs update, etc)

## Checklist before merging

- [x] Test, docs, adr added or updated as needed
- [x] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed

---------

Co-authored-by: razzle <harry@razzle.cloud>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lucasrod16 lucasrod16

Labels
tech-debt 💳 Debt that the team has charged and needs to repay
Projects
Zarf
Status: Done
Zarf Project Board
Status: Closed
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

ci: add commitlint workflow and update contributing guide defenseunicorns/zarf
1 participant
@lucasrod16