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

Add readme #2

Merged
merged 3 commits into from
Nov 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@
"yireo/magento2-extensionchecker": "^2.2"
},
"type": "magento2-module",
"license": [
"OSL-3.0",
"AFL-3.0"
],
"license": "OSL-3.0",
"autoload": {
"files": [
"registration.php"
Expand Down
31 changes: 31 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Iranimij_GitExtensionChecker

The **Iranimij_GitExtensionChecker** module is an enhancement of the `Yireo_ExtensionChecker` module. It focuses on analyzing the dependencies of Magento 2 modules that have been modified in the current Git branch compared to the `main` branch. This helps ensure that only the relevant module dependencies are checked, streamlining your development workflow.

## Features

- Detects modified modules by comparing the current branch with the `main` branch.
- Checks the dependencies of only the changed modules.
- Integrates seamlessly with Magento 2 development processes.

## Installation

To install the module, use Composer and run the Magento setup commands:

```bash
composer require iranimij/magento-git-extension-checker
bin/magento setup:upgrade
```

### Requirements
* Magento 2.4.x or higher
* PHP 8.0 or higher

## Usage

```bash
bin/magento Iranimij_GitExtensionChecker:scan
```

## License
OSL-3.0