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

feat: Implement conventional commit validation #418

Merged
merged 2 commits into from
Dec 9, 2024

Conversation

mahdichtioui
Copy link
Contributor

@mahdichtioui mahdichtioui commented Nov 28, 2024

GitHub Issue: #

Proposed Changes

  • Bug fix
  • Feature
  • Code style update (formatting)
  • Refactoring (no functional changes, no api changes)
  • Build or CI related changes
  • Documentation content changes
  • Other, please describe:

Description

Impact on version

  • Major
    • The template structure was changed.
  • Minor
    • New functionalities were added.
  • Patch
    • A bug in behavior was fixed.
    • Documentation was changed.

PR Checklist

Always applicable

No matter your changes, these checks always apply.

  • Your conventional commits are aligned with the Impact on version section.
  • Updated CHANGELOG.md.
    • Use the latest Major.Minor.X header if you do a Patch change.
    • Create a new Major.Minor.X header if you do a Minor or Major change.
    • If you create a new header, it aligns with the Impact on version section and matches what is generated in the build pipeline.
  • Documentation files were updated according with the changes.
    • Update README.md and TemplateConfig.md if you made changes to templating.
    • Update AzurePipelines.md and APP_README.md if you made changes to pipelines.
    • Update Diagnostics.md if you made changes to diagnostic tools.
    • Update Architecture.md and its diagrams if you made architecture decisions or if you introduced new recipes.
    • ...and so forth: Make sure you update the documentation files associated to the recipes you changed. Review the topics by looking at the content of the doc/ folder.
  • Images about the template are referenced from the wiki and added as images in this git.
  • TODO comments are hints for next steps for users of the template and not planned work.

Contextual

Based on your changes these checks may not apply.

  • Automated tests for the changes have been added/updated.
  • Tested on all relevant platforms

Other information

Internal Issue (If applicable):

@jeanplevesque
Copy link
Member

This PR is more about CI than documentation, please update the Proposed Changes section of the PR description. Thanks!

@MatFillion
Copy link
Member

I would have made it its own step and validate commits only once instead of validating in each platform. Are there benefits of doing it in each platform?

@carlh98
Copy link
Contributor

carlh98 commented Nov 28, 2024

@MatFillion that's what was done in a project shown in an example internally but I agree I would change it to run it once.

@jeanplevesque
Copy link
Member

jeanplevesque commented Nov 28, 2024

I would have made it its own step and validate commits only once instead of validating in each platform. Are there benefits of doing it in each platform?

You mean have a stage dedicated to this validation?
Yes we could do it that way.

@mahdichtioui
Copy link
Contributor Author

I would have made it its own step and validate commits only once instead of validating in each platform. Are there benefits of doing it in each platform?

I agree. It makes more sense to run it once

@MatFillion
Copy link
Member

Correct, in it's own stage would be the correct term, not step.

@lamonfly
Copy link
Contributor

lamonfly commented Dec 3, 2024

This should be one ci commit.
Don't forget to go through the PR checklist. It should mention to bump the minor version and update the documentation.

@lamonfly lamonfly self-requested a review December 3, 2024 13:59
@mahdichtioui mahdichtioui force-pushed the dev/mach/implement-commit-validation branch 2 times, most recently from 80dd8d0 to daf117f Compare December 3, 2024 15:34
@mahdichtioui mahdichtioui marked this pull request as draft December 4, 2024 09:15
@mahdichtioui mahdichtioui force-pushed the dev/mach/implement-commit-validation branch from daf117f to eb222c7 Compare December 5, 2024 09:38
@mahdichtioui mahdichtioui marked this pull request as ready for review December 5, 2024 14:16
@jeanplevesque jeanplevesque force-pushed the dev/mach/implement-commit-validation branch from eb222c7 to 773cffb Compare December 6, 2024 13:35
.azure-pipelines.yml Show resolved Hide resolved
@mahdichtioui mahdichtioui force-pushed the dev/mach/implement-commit-validation branch from 69a9d07 to 9ae00d9 Compare December 6, 2024 14:53
CHANGELOG.md Outdated Show resolved Hide resolved
@mahdichtioui mahdichtioui changed the title ci: Implement conventional commit validation feat:: Implement conventional commit validation Dec 6, 2024
@mahdichtioui mahdichtioui changed the title feat:: Implement conventional commit validation feat: Implement conventional commit validation Dec 6, 2024
@mahdichtioui mahdichtioui force-pushed the dev/mach/implement-commit-validation branch from f63e711 to 7c08a8d Compare December 6, 2024 16:59
CHANGELOG.md Outdated Show resolved Hide resolved
@mahdichtioui mahdichtioui force-pushed the dev/mach/implement-commit-validation branch from 88520cc to dd55ca9 Compare December 9, 2024 13:26
@jeanplevesque jeanplevesque requested a review from a team December 9, 2024 14:40
@mahdichtioui mahdichtioui merged commit af371d8 into main Dec 9, 2024
15 checks passed
@mahdichtioui mahdichtioui deleted the dev/mach/implement-commit-validation branch December 9, 2024 17:18
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.

6 participants