Skip to content

Conversation

@ThatDeparted2061
Copy link
Member

@ThatDeparted2061 ThatDeparted2061 commented Sep 15, 2025

Fixes #631
Fixed #571

This is a precursor for the Release Pipelines
I have added the conventional-commit workflow, This is required for Release notes Automation

Screenshots of the changes (If any) -

Note: Please check Allow edits from maintainers. if you would like us to assist in the PR.

Summary by CodeRabbit

  • Chores
    • Added an automated workflow to validate commit messages against the Conventional Commits specification for pushes and pull requests targeting main. This enforces consistent commit conventions, improves commit history readability, and streamlines reviews. No changes to application behavior or public APIs; minimal review effort required.

@netlify
Copy link

netlify bot commented Sep 15, 2025

Deploy Preview for circuitverse ready!

Name Link
🔨 Latest commit a5a6d42
🔍 Latest deploy log https://app.netlify.com/projects/circuitverse/deploys/68c869cb11f6140008630ff3
😎 Deploy Preview https://deploy-preview-656--circuitverse.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 45 (🟢 up 1 from production)
Accessibility: 73 (no change from production)
Best Practices: 92 (no change from production)
SEO: 82 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 15, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Adds a new GitHub Actions workflow at .github/workflows/conventional-commit.yml that runs on pushes to main and pull requests targeting main, and validates commit messages against the Conventional Commits specification.

Changes

Cohort / File(s) Summary of Changes
CI workflow: Conventional Commits check
.github/workflows/conventional-commit.yml
Adds a workflow triggered on push and pull_request events targeting main. Defines a check-commits job on ubuntu-latest with contents: read and pull-requests: read permissions. Job steps: actions/checkout@v4 and webiny/[email protected] to validate commit messages.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Linked Issues Check ⚠️ Warning The PR adds a Conventional Commits verification workflow which directly supports the release-notes automation objective from issue [#631] by enforcing commit message structure usable by conventional-changelog, but it does not implement the other primary coding objectives from the linked issues—specifically code signing and deployment of release pipelines requested in [#631] and [#571]—so the change only partially satisfies the linked issues' requirements. To comply with the linked issues, extend this PR or add follow-up PRs to integrate conventional-changelog in CI to generate release notes, add release pipeline configuration to publish versioned releases, and implement code-signing integration (e.g., SignPath or equivalent); alternatively, update the PR description to clearly mark this as a preparatory change and link planned follow-up tasks and PRs.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "chore: create conventional-commit workflow" is concise and accurately describes the primary change (adding a Conventional Commits enforcement workflow), uses a conventional-commit prefix, and directly corresponds to the single new file in the changeset.
Out of Scope Changes Check ✅ Passed The changeset is limited to adding .github/workflows/conventional-commit.yml to enforce Conventional Commits and is directly related to the linked issues' need for conventional-changelog prerequisites; I do not see any unrelated or out-of-scope file modifications.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3304942 and a5a6d42.

📒 Files selected for processing (1)
  • .github/workflows/conventional-commit.yml (1 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@ThatDeparted2061
Copy link
Member Author

@aryanndwi123 @niladrix719

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.github/workflows/conventional-commit.yml (1)

1-16: Also validate PR titles if you squash-merge.

If merges are squashed, the final commit message comes from the PR title, not individual commits. Add a PR-title semantic check (e.g., amannn/action-semantic-pull-request).

Example additional job:

jobs:
  semantic-pr-title:
    permissions:
      pull-requests: read
      statuses: write
    runs-on: ubuntu-latest
    if: github.event_name == 'pull_request'
    steps:
      - uses: amannn/action-semantic-pull-request@v5
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
🧹 Nitpick comments (1)
.github/workflows/conventional-commit.yml (1)

14-14: Consider full history fetch to avoid edge cases.

If the action inspects commit history on push, set fetch-depth: 0. Low cost, avoids shallow clone pitfalls.

-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a1ff6c5 and 3304942.

📒 Files selected for processing (1)
  • .github/workflows/conventional-commit.yml (1 hunks)
🔇 Additional comments (1)
.github/workflows/conventional-commit.yml (1)

14-15: Pin actions to release commit SHAs; webiny/action-conventional-commits v1.3.0 is current.

Pin actions to full commit SHAs for supply‑chain hardening. webiny/action-conventional-commits v1.3.0 is actively maintained (release SHA: 8bc41ff4e7d423d56fa4905f6ff79209a78776c7 — released 2025-05-20). actions/checkout has a v5 release (v5.0.0 SHA: 08c6903cd8c0fde910a37f88322edcfb5dd907a8) — either upgrade to v5 and pin that SHA or pin your current v4 to its release SHA.

File: .github/workflows/conventional-commit.yml
Lines: 14-15

Example (replace with the release commit SHA):

-      - uses: actions/checkout@v4
+      - uses: actions/checkout@<sha> # v4
-      - uses: webiny/[email protected]
+      - uses: webiny/action-conventional-commits@<sha> # v1.3.0

@niladrix719 niladrix719 enabled auto-merge (squash) September 15, 2025 19:33
Copy link
Member

@niladrix719 niladrix719 left a comment

Choose a reason for hiding this comment

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

lgtm

@niladrix719 niladrix719 merged commit ed8eb1c into CircuitVerse:main Sep 15, 2025
8 of 9 checks passed
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.

Implement Code Signing and Release Notes Automation Deploy Release pipelines

2 participants