Skip to content

ci: sync files with laravel-package-tpl #711

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
Merged
merged 1 commit into from
Apr 28, 2024
Merged

ci: sync files with laravel-package-tpl #711

merged 1 commit into from
Apr 28, 2024

Conversation

lotyp
Copy link
Member

@lotyp lotyp commented Apr 28, 2024 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features
    • Introduced GitHub issue templates for bug reports, feature requests, failing tests, documentation issues, and security reports.
    • Added a new markdown linting configuration.
    • Implemented a pre-commit configuration with hooks for PHP and Markdown linting.
  • Documentation
    • Updated the Code of Conduct with enhanced email and URL formatting.
    • Enhanced README files with improved layout, alignment, and content structure.
  • Chores
    • Added a new code owner for repository files.
    • Updated labeler patterns for better commit categorization.
    • Modified Makefile to use variables for Docker commands and added new linting targets.
  • Refactor
    • Removed a rule override in the YAML linting configuration.

@lotyp
ci: sync files with laravel-package-tpl
ea16507 
Latest updates with laravel-package-tpl template.

style: applied markdown-linting

ci: added default CODEOWNERS

ci: added default issue templates

ci: updated rules for labeler

cI: updates to pre-commit config, added php-cs-fixer and markdown validations

ci: added markdown linter support
@vercel Vercel
Copy link

vercel bot commented Apr 28, 2024 •
edited
Loading

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

Name Status Preview Comments Updated (UTC)
laravel-cycle-orm-adapter ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 28, 2024 11:28pm

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Apr 28, 2024 •
edited
Loading

Walkthrough

The repository has undergone significant updates, enhancing its structure, security, and documentation. New templates for issues and a CODEOWNERS file improve project management and responsibility delineation. Changes to configuration files like .markdownlint.json and .yamllint.yaml refine coding standards and linting processes. Additionally, updates to the Makefile and READMEs improve usability and clarity, ensuring better project maintenance and presentation.

Changes

File Path Change Summary
.github/CODEOWNERS Added to specify @lotyp as the code owner for all files.
.github/CODE_OF_CONDUCT.md Updated email and URL formatting.
.github/ISSUE_TEMPLATE/... Introduced various templates for bug reports, feature requests, failing tests, docs issues, and security reports.
.github/labeler.yml Adjusted labeling patterns for commits.
.markdownlint.json, .yamllint.yaml Configured lint settings; removed a rule override in .yamllint.yaml.
.pre-commit-config.yaml Added hooks for PHP CS Fixer and markdownlint-cli2.
Makefile Updated Docker commands and added new linting targets.
README.md, docs/README.md Restructured content and updated visual elements.

🐰✨
Oh hark! What changes we now see,
From docs to code, improvements be.
A rabbit's leap in code so clean,
With templates fresh and linting keen.
Hop, hop, hurray on this fine day,
For better code has come to stay!
🌟📜

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 90f651a and ea16507.
Files ignored due to path filters (1)
  • composer.lock is excluded by !**/*.lock
Files selected for processing (15)
  • .github/CODEOWNERS (1 hunks)
  • .github/CODE_OF_CONDUCT.md (2 hunks)
  • .github/ISSUE_TEMPLATE/1-bug-report.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/2-feature-request.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/3-failing-test.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/4-docs-bug-report.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/5-security-report.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/config.yml (1 hunks)
  • .github/labeler.yml (1 hunks)
  • .markdownlint.json (1 hunks)
  • .pre-commit-config.yaml (1 hunks)
  • .yamllint.yaml (1 hunks)
  • Makefile (7 hunks)
  • README.md (3 hunks)
  • docs/README.md (1 hunks)
Files skipped from review due to trivial changes (6)
  • .github/ISSUE_TEMPLATE/2-feature-request.yml
  • .github/ISSUE_TEMPLATE/3-failing-test.yml
  • .github/ISSUE_TEMPLATE/4-docs-bug-report.yml
  • .github/ISSUE_TEMPLATE/5-security-report.yml
  • .markdownlint.json
  • .yamllint.yaml
Additional Context Used
LanguageTool (27)
.github/CODE_OF_CONDUCT.md (2)

Near line 32: Try using a synonym here to strengthen your wording.
Context: ...ind * Trolling, insulting or derogatory comments, and personal or political attacks * Pu...

Near line 109: It seems like there are too many consecutive spaces here.
Context: ...luding sustained inappropriate behavior, harassment of an individual, or aggressi...

README.md (20)

Near line 40: Possible spelling mistake found.
Context: ...ign) in your Laravel projects with the [wayofdev/laravel-cycle-orm-adapter](https://gith...

Near line 40: Possible spelling mistake found.
Context: ...our Laravel projects with the [wayofdev/laravel-cycle-orm-adapter](https://github.com/wayofdev/laravel-cy...

Near line 40: Possible spelling mistake found.
Context: ...mlessly integrates the capabilities of CycleORM — DataMapper OR...

Near line 40: Possible spelling mistake found.
Context: ... of CycleORM — DataMapper ORM into [Laravel Framework](https://la...

Near line 60: Possible typo: you repeated a whitespace
Context: ...--------|-----------|---------| | ^10.28 | 2.x | 4.x | | 11.x | 2.x ...

Near line 60: Possible typo: you repeated a whitespace
Context: ...-|-----------|---------| | ^10.28 | 2.x | 4.x | | 11.x | 2.x | ^4.9...

Near line 60: Possible typo: you repeated a whitespace
Context: ...-|---------| | ^10.28 | 2.x | 4.x | | 11.x | 2.x | ^4.9.0 | <br...

Near line 61: Possible typo: you repeated a whitespace
Context: ...| ^10.28 | 2.x | 4.x | | 11.x | 2.x | ^4.9.0 |
## 🙌 Wan...

Near line 61: Possible typo: you repeated a whitespace
Context: ... | 2.x | 4.x | | 11.x | 2.x | ^4.9.0 |
## 🙌 Want to Contrib...

Near line 61: Possible typo: you repeated a whitespace
Context: ...4.x | | 11.x | 2.x | ^4.9.0 |
## 🙌 Want to Contribute? Than...

Near line 67: Possible spelling mistake found.
Context: ...you for considering contributing to the wayofdev community! We are open to all kinds of ...

Near line 67: This phrasing can be overused. Try elevating your writing with a more formal alternative.
Context: ...are open to all kinds of contributions. If you want to: - 🤔 [Suggest a feature](https://gith...

Near line 69: Unpaired symbol: ‘]’ seems to be missing
Context: ...of contributions. If you want to: - 🤔 [Suggest a feature](https://github.com/wa...

Near line 70: Unpaired symbol: ‘]’ seems to be missing
Context: ...quest.yml&title=%5BFeature%5D%3A+) - 🐛 [Report an issue](https://github.com/wayo...

Near line 71: Unpaired symbol: ‘]’ seems to be missing
Context: ...ug-report.yml&title=%5BBug%5D%3A+) - 📖 [Improve documentation](https://github.co...

Near line 90: Possible spelling mistake found.
Context: ...? Resources and Credits - Inspired by [butschster's](https://github.com/butschster/Larave...

Near line 94: Unpaired symbol: ‘]’ seems to be missing
Context: ...plementation of Cycle ORM for Laravel — [wakebit/laravel-cycle](https://github.co...

Near line 94: Possible spelling mistake found.
Context: ...lementation of Cycle ORM for Laravel — [wakebit/laravel-cycle](https://github.com/wakeb...

Near line 94: Possible spelling mistake found.
Context: ...ion of Cycle ORM for Laravel — [wakebit/laravel-cycle](https://github.com/wakebit/laravel-cyc...

Near line 101: Only proper nouns start with an uppercase character (there are exceptions for headlines).
Context: ...low?screen_name=wlotyp). - Discord: Join our community on [Discord](https://disc...

docs/README.md (5)

Near line 40: Possible spelling mistake found.
Context: ...tory contains the documentation for the wayofdev/laravel-cycle-orm-adapter package. Th...

Near line 42: Possible spelling mistake found.
Context: ...kage. The documentation is built with Nextra and hosted on [Ve...

Near line 42: Possible spelling mistake found.
Context: ...ra](https://nextra.site) and hosted on Vercel.
## 🛠️ Loc...

Near line 50: Possible spelling mistake found.
Context: ...Development ### → Option 1 First, run pnpm i to install the dependencies. Then, ...

Near line 52: Possible spelling mistake found.
Context: ...to install the dependencies. Then, run pnpm dev to start the development server an...

Additional comments not posted (22)
.github/CODEOWNERS (1)

3-3: LGTM! The assignment of @lotyp as the code owner for all files is correctly implemented.

.github/ISSUE_TEMPLATE/config.yml (2)

3-3: LGTM! Enabling blank issues is correctly configured.

5-12: LGTM! The contact links for discussions and Discord community are well-defined and correctly implemented.

.github/labeler.yml (4)

6-8: LGTM! The regex patterns for "type: bug" are correctly added.

9-10: LGTM! The updated regex patterns for "type: enhancement" are correctly implemented.

14-14: LGTM! The modified file paths for "type: documentation" are correctly updated.

18-18: LGTM! The adjusted file paths for "type: maintenance" are correctly updated.

.pre-commit-config.yaml (2)

19-30: LGTM! The configuration for the PHP CS Fixer hook is correctly implemented.

32-39: LGTM! The configuration for the markdownlint-cli2 hook is correctly implemented.

.github/ISSUE_TEMPLATE/1-bug-report.yml (2)

3-10: LGTM! The structure and fields for the bug report template are correctly defined.

11-101: LGTM! The detailed sections within the bug report template, including descriptions and validations, are well-implemented.

docs/README.md (2)

1-36: LGTM! The introductory section with the project logo and badges is well-structured and visually appealing.

38-66: LGTM! The documentation content, including the local development instructions and license information, is clear and informative.

.github/CODE_OF_CONDUCT.md (2)

63-63: LGTM! The email address is correctly formatted with angle brackets.

119-128: LGTM! The URLs in the attribution and FAQ sections are correctly formatted with angle brackets.

README.md (2)

1-35: LGTM! The introductory section with the project logo and badges is well-structured and visually appealing.

65-105: LGTM! The sections on contributing, resources, and license information are clear and informative.

Makefile (5)

12-12: Change in DOCKER_COMPOSE variable enhances flexibility by allowing easy configuration of the Docker binary.

20-20: Update to BUILDER_PARAMS ensures Docker environment consistency with project settings.

43-46: Update to MARKDOWN_LINT_RUNNER aligns with enhanced linting configurations and ensures consistency across environments.

197-198: Update to lint-md target to include automatic fixing of lint errors enhances markdown file quality.

283-283: Update to docs-deps-update target ensures documentation dependencies are kept up-to-date.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added type: enhancement For features and enhancements (feat) type: documentation labels Apr 28, 2024
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.94%. Comparing base (90f651a) to head (ea16507).

Additional details and impacted files 
@@            Coverage Diff            @@
##             master     #711   +/-   ##
=========================================
  Coverage     75.94%   75.94%           
  Complexity      252      252           
=========================================
  Files            46       46           
  Lines           927      927           
=========================================
  Hits            704      704           
  Misses          223      223

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lotyp lotyp merged commit e98533f into master Apr 28, 2024
@lotyp lotyp deleted the feat/infra-dx branch April 28, 2024 23:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
type: documentation type: enhancement For features and enhancements (feat)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lotyp @codecov-commenter