README

介绍

本指南提供了创建简单模块的步骤，通过 Composer 在第三方或您自己的 Magento 2 项目中安装它，并将其与 GitHub 连接的同时上传到 Packagist.org。

创建简单模块

创建模块结构
- 为您的 Magento 2 模块创建必要的目录和文件。

定义 composer.json

在模块根目录中创建一个名为 composer.json 的文件，内容如下

{
  "name": "simpsons/composermode",
  "description": "A simple Magento 2 module",
  "require": {
    "php": "^8.1"
  },
  "type": "magento2-module",
  "version": "1.0.0",
  "autoload": {
    "files": [
      "registration.php"
    ],
    "psr-4": {
      "Simpsons\\ComposerModule\\": ""
    }
  }
}

创建模块文件
- 根据 Magento 2 的要求创建 registration.php 和 module.xml 文件。

通过 Composer 安装模块

安装模块

使用以下命令安装模块

composer require simpsons/composermode dev-main

要求

PHP 8.1 是兼容性所必需的。

将您的包上传到 Packagist.org

在 Packagist.org 上创建账户
- 访问 Packagist.org 并注册一个新账户。
- 验证您的电子邮件地址以激活账户。
提交您的包
- 登录后，点击顶部菜单中的“提交”。
- 输入您 GitHub 仓库的 URL 并点击“检查”。
- 验证后，提交您的包。

将 GitHub 与 Packagist 连接

链接您的 GitHub 账户
- 前往您的 Packagist 个人资料并点击“设置”。
- 点击“链接 GitHub 账户”并按照说明授权 Packagist 访问您的 GitHub 仓库。
自动化包更新
- 在您的 GitHub 仓库中，导航到“设置” > “Webhooks”。
- 添加一个新的 webhook，以下为详细信息
  - 有效负载 URL: https://packagist.org.cn/api/github
  - 内容类型: application/json
  - 事件: 选择“仅推送事件”。
- 保存 webhook。

总结

按照上述步骤，您可以创建一个简单的 Magento 2 模块，使用 Composer 进行安装，并在 Packagist.org 上管理您的包。确保您的模块符合 PHP 8.1 的兼容性要求。

simpsons / composermode

维护者

详细信息

README

介绍

创建简单模块

通过 Composer 安装模块

要求

将您的包上传到 Packagist.org

将 GitHub 与 Packagist 连接

总结