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

ci: Add action to lint PR titles #956

Merged
merged 1 commit into from
Dec 6, 2024
Merged

ci: Add action to lint PR titles #956

merged 1 commit into from
Dec 6, 2024

Conversation

tushar-composio
Copy link
Contributor

@tushar-composio tushar-composio commented Dec 6, 2024

PR titles must follow conventional commits:

fix: Edge case in Outlook action
feat: New flow for OpenAPI spec uploads
chore: Bump version
ci: Update cache action to latest version

etc.

Important

Adds GitHub Action to validate pull request titles for semantic format using amannn/action-semantic-pull-request.

  • CI/CD:
    • Adds .github/workflows/pr_title.yml to check PR titles for semantic format.
    • Triggers on opened, edited, synchronize, and reopened pull request events.
    • Uses amannn/action-semantic-pull-request@v5 to validate titles.
  • Permissions:
    • Requires pull-requests: read permission.

This description was created by Ellipsis for 09a50ed. It will automatically update as commits are pushed.

Copy link

vercel bot commented Dec 6, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
composio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 6, 2024 6:45am

@tushar-composio tushar-composio changed the title ci: add action to lint PR titles Add action to lint PR titles Dec 6, 2024
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

❌ Changes requested. Reviewed everything up to 09a50ed in 35 seconds

More details
  • Looked at 27 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 0 drafted comments based on config settings.

Workflow ID: wflow_pXvw8oxdnHcswjV4


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

name: Validate PR title
runs-on: ubuntu-latest
steps:
- uses: amannn/action-semantic-pull-request@v5
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider adding a configuration for the action-semantic-pull-request to specify the expected PR title format. This ensures the action checks against the desired title conventions.

@tushar-composio tushar-composio changed the title Add action to lint PR titles pr: Add action to lint PR titles Dec 6, 2024
@tushar-composio tushar-composio changed the title pr: Add action to lint PR titles ci: Add action to lint PR titles Dec 6, 2024
@tushar-composio tushar-composio merged commit a5b87d1 into master Dec 6, 2024
9 of 14 checks passed
@tushar-composio tushar-composio deleted the pr-title-lint branch December 6, 2024 06:46
name: Validate PR title
runs-on: ubuntu-latest
steps:
- uses: amannn/action-semantic-pull-request@v5
Copy link
Collaborator

Choose a reason for hiding this comment

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

Consider adding configuration options for the semantic PR action to match the project's existing commit message standards. For example:

- uses: amannn/action-semantic-pull-request@v5
  with:
    # Define allowed types based on your development.md guidelines
    types: |
      feat
      fix
      docs
      test
    # Add a helpful error message
    errorComment: |
      Please follow the semantic PR title format as defined in python/docs/development.md

@shreysingla11
Copy link
Collaborator

Review Summary

Code Quality: 8/10

Positive Aspects:

  • Well-structured GitHub Actions workflow
  • Appropriate trigger events and minimal permissions
  • Uses stable version (v5) of the semantic PR action
  • Aligns with existing project standards documented in development.md

Suggestions for Improvement:

  1. Add configuration options to match project's existing commit message standards
  2. Consider adding helpful error messages for failed validations
  3. Update development.md to reference this new automated check

The implementation is solid and will help enforce the project's existing semantic commit standards. The suggestions are mainly about improving user experience rather than fixing technical issues.

Copy link

github-actions bot commented Dec 6, 2024

This comment was generated by github-actions[bot]!

JS SDK Coverage Report

📊 Coverage report for JS SDK can be found at the following URL:
https://pub-92e668239ab84bfd80ee07d61e9d2f40.r2.dev/coverage-12194294039/coverage/index.html

📁 Test report folder can be found at the following URL:
https://pub-92e668239ab84bfd80ee07d61e9d2f40.r2.dev/html-report-12194294039/html-report/report.html

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