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

chore: configure semantic validation #2577

Merged
merged 1 commit into from
Nov 17, 2024

Conversation

AsCress
Copy link
Contributor

@AsCress AsCress commented Nov 17, 2024

Adds Semantic Validation for our pull requests in the development branch.

Screenshots / Recordings

N/A

Checklist:

  • No hard coding: I have used resources from strings.xml, dimens.xml and colors.xml without hard coding any value.
  • No end of file edits: No modifications done at end of resource files strings.xml, dimens.xml or colors.xml.
  • Code reformatting: I have reformatted code and fixed indentation in every file included in this pull request.
  • No extra space: My code does not contain any extra lines or extra spaces than the ones that are necessary.

Summary by Sourcery

CI:

  • Add a GitHub Actions workflow for semantic validation of pull request titles.

Copy link

sourcery-ai bot commented Nov 17, 2024

Reviewer's Guide by Sourcery

This PR implements semantic validation for pull requests by adding a GitHub Actions workflow. The workflow uses the action-semantic-pull-request action to validate PR titles against semantic commit conventions.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added GitHub Actions workflow for semantic PR title validation
  • Configured workflow to trigger on PR open, edit, and synchronize events
  • Set up permissions to allow writing to pull requests
  • Implemented PR title validation using amannn/action-semantic-pull-request@v5
  • Added configuration to ignore PRs with 'chore(deps)' label
.github/workflows/semantic_lint.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @AsCress - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟡 Security: 1 issue found
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

.github/workflows/semantic_lint.yml Show resolved Hide resolved
Copy link

@AsCress AsCress added Chore Changes to things that do not go into production github_actions Pull requests that update GitHub Actions code labels Nov 17, 2024
@adityastic adityastic enabled auto-merge (squash) November 17, 2024 07:13
@adityastic adityastic merged commit 5c4f88c into fossasia:development Nov 17, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Chore Changes to things that do not go into production github_actions Pull requests that update GitHub Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants