展开菜单
首页 精品内容 本月促销 装机必备 Windows macOS软件 IOS软件 Android AI PDF教程 专题
全部分类

当前位置:

首页 > 编程开发 > Composer如何配置项目的支持链接_在json添加issue和wiki地址【项目文档】

Composer如何配置项目的支持链接_在json添加issue和wiki地址【项目文档】

在 composer.json 根对象的 support 字段下添加 issues 和 wiki 子键,值为完整 HTTPS URL,如 "support": {"issues": "https://...", "wiki": "https://..."},并确保 Packagist 已同步最新配置

在 composer.json 根对象的 support 字段下添加 issues 和 wiki 子键,值为完整 HTTPS URL,如 "support": {"issues": "https://...", "wiki": "https://..."},并确保 Packagist 已同步最新配置。

Composer如何配置项目的支持链接_在json添加issue和wiki地址【项目文档】

composer.json 里怎么加 issue tracker 和 wiki 链接

虽然 Composer 这个工具本身并不会去解析 issueswiki 字段,但这里有个关键点:主流的 PHP 包仓库 Packagist 会识别它们。只要你在 composer.json 文件的顶层,按照正确的格式写好这两个字段,一旦发布到 Packagist,你的项目页面右上角就会自动出现对应的图标和跳转链接。

配置的位置有严格要求,必须写在根对象下,可别嵌套在 extra 或其他字段里:

{
    "name": "vendor/package",
    "description": "A sample package",
    "homepage": "https://example.com",
    "support": {
        "issues": "https://github.com/vendor/package/issues",
        "wiki": "https://github.com/vendor/package/wiki"
    }
}
  • support 是必须使用的外层字段名,大小写敏感,写成 Supportsupport-info 可不行。
  • issueswikisupport 对象下的子键,它们的值必须是完整且可访问的 HTTPS URL。
  • 对于 GitHub 或 GitLab 项目,虽然默认提供了 issues 和 wiki 功能,但路径一定要写全。当然,如果你的仓库禁用了 issues,那么即使填了链接,用户点开也只会看到 404。
  • 这里有个小细节:Packagist 并不会主动校验你填的 URL 是否真实可达,它只是原封不动地展示出来。所以,如果地址填错了,最终只会让点击的用户感到失望。

为什么 support.issues 没出现在 Packagist 页面上

配置明明写对了,但 Packagist 页面上就是看不到按钮?最常见的原因其实很简单:你修改了 composer.json,但没有触发 Packagist 的同步。要知道,Packagist 不会自动轮询你的代码仓库,它依赖的是 GitHub/GitLab 的 webhook 通知,或者你的手动更新操作。

  • 首先,确认你的 GitHub 仓库是否已经接入了 Packagist 的 webhook。可以到仓库的 Settings → Webhooks 里查看,是否包含来自 packagist.org 的回调地址。
  • 如果没有设置 webhook,也别急。直接登录 Packagist,进入个人页面,找到对应的包,点击 “Update” 按钮,强制拉取最新的 composer.json 配置。
  • 然后,检查 Packagist 项目页面右上角,在「Source」按钮旁边,是否出现了「Issues」和「Wiki」按钮。如果还是没有,那很可能就是 support 字段的结构没有被正确识别,比如缩进错误、遗漏了逗号,或者不小心用了单引号。
  • 运行 composer validate 命令可以快速发现 JSON 语法问题,但要注意,它不会报告 support 字段无效——因为这个字段本身是合法的,只是它的“消费者”是 Packagist,而非 Composer 工具本身。

除了 issues 和 wiki,support 还能填什么

support 字段组是 Packagist 明确支持的一套元信息容器。除了最常用的 issueswiki,它还接受以下这些可选键:

  • email:联系邮箱,会显示为一个 mailto: 链接。
  • irc:IRC 频道地址,格式例如 irc://irc.freenode.net/#package
  • source:源码仓库地址(通常和 homepagerepositories 里的配置一致,Packagist 会优先使用仓库本身的配置)。
  • docs:独立的文档站点地址,比如 ReadTheDocs 的链接,这区别于 wiki。
  • rss:RSS 订阅源(这个用得比较少)。

需要明确的是,support 下的所有字段都不会影响 Composer 的安装行为,它们纯粹是为了展示项目支持信息。但话说回来,如果用户第一眼看到「Wiki」按钮,兴冲冲点进去却跳转到 404 页面,那可比没有这个按钮更伤信任。

要不要把 issue 模板也塞进 composer.json

答案是:不用,而且也不能。GitHub 或 GitLab 的 issue 模板,是存放在仓库根目录下 .github/ISSUE_TEMPLATE/ 这样的文件系统结构里的,这和 composer.json 的配置完全是两码事。Composer 既不会读取、也不会转发或校验这些模板文件。

如果你希望贡献者在提交 issue 时能自动套用格式,唯一有效的做法是:

  • 在 GitHub 仓库中,通过创建 .github/ISSUE_TEMPLATE/bug_report.md 这类文件来启用 issue 模板。
  • 确保 composer.jsonsupport.issues 指向的是该仓库的 issues 列表主页(例如 https://github.com/vendor/package/issues),而不是某个具体的 issue 链接。
  • 别试图用 extra 字段来模拟支持链接——Packagist 会忽略它,用户自然也看不到。

其实,真正容易踩坑的地方往往就三个:字段名的拼写、URL 的可访问性,以及 Packagist 的同步机制。这三者缺了任何一个,你配置的链接就等于白费功夫。

本文内容来源于互联网,如有侵权请联系删除。
作者最新文章
编程开发
相关文章 更多
精品专题 更多
本月促销

正软商城本月促销专区,汇集办公、设计、安全、影音、系统工具及AI软件等正版软件优惠活动,提供限时折扣、特价授权和优惠购买信息,活动库存及价格以页面实时展示为准。

装机必备

正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

Windows

正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

macOS软件

正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

IOS软件

正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

AI

正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

PDF教程

正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

Mac软件 更多
灵活计算器
灵活计算器

灵活计算器是一款笔记式算数应用,支持实时计算、动态关联和云端同步功能。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

赤友清理大师
赤友清理大师

赤友清理大师是一款为 Mac 设计的智能清理优化工具,可精准扫描垃圾、大文件、重复文件等,释放磁盘空间。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

极度公式
极度公式

极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

图几
图几

图几是一款适用于 macOS 的截图、标注与美化工具,支持离线操作保障隐私。界面整理和高频系统操作被放到一起考虑,桌面或窗口内容一多时,管理起来会更省心。

密码键盘
密码键盘

密码键盘是一款兼具安全性与便捷性的高效密码管理器。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

思源笔记
思源笔记

思源笔记是一款本地笔记软件,提供所见即所得的编辑方式,为长文写作带来顺滑的体验。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

Office 365 简体中文
Office 365 简体中文

一款文字处理软件,一种订阅式的跨平台办公软件,基于云平台提供多种服务,通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合,Office 365 可让任何人使用任何设备随时随地创建和共享内容。

WALTR PRO
WALTR PRO

WALTR是一款电脑至iOS文件传输转换工具,操作简单,快速实现文件识别与传送。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

CodeExpander
CodeExpander

CodeExpander 是一款快捷短语输入增强工具,通过键入缩写自动展开为自定义文段,提升工作效率。任务管理和过程控制会更完整,持续下载、批量同步或需要稳定传输流程的场景会更适合它。

Mountain Duck
Mountain Duck

Mountain Duck 是一款能将多个网盘挂载到本地的工具,像本地磁盘一样使用网盘。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

Menuist
Menuist

Menuist 是一款面向 macOS 的 Finder 右键菜单增强工具,主要用来补充新建文件、快捷导航等常用操作,让日常文件管理和访问路径时更高效、更顺手。

Mole
Mole

Mole 是一款专为 Mac 设计的深度清理优化工具,涵盖缓存清理、应用管理及实时状态监控等功能。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

WINDOWS 更多
Windows 10
Windows 10

Windows 10 是一款微软推出的经典操作系统,拥有硬件兼容性与多任务处理能力。它更偏向把系统状态查看和常用调节动作放在一起,适合需要持续观察和微调设备状态的场景。

极度公式
极度公式

极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

密码键盘
密码键盘

密码键盘是一款兼具安全性与便捷性的高效密码管理器。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

思源笔记
思源笔记

思源笔记是一款本地笔记软件,提供所见即所得的编辑方式,为长文写作带来顺滑的体验。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

傲梅轻松备份
傲梅轻松备份

傲梅轻松备份是一款专业易用的数据备份软件,为重要数据提供安全保障。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。

Office 365 简体中文
Office 365 简体中文

一款文字处理软件,一种订阅式的跨平台办公软件,基于云平台提供多种服务,通过将 Excel 和 Outlook 等应用与 OneDrive 和 Microsoft Teams 等强大的云服务相结合,Office 365 可让任何人使用任何设备随时随地创建和共享内容。

Wise Folder Hider Pro
Wise Folder Hider Pro

Wise Folder Hider Pro 是一款专业级文件和文件夹隐藏加密软件,为私密数据添加多重保护。高频操作更强调就近处理,浏览、整理和跨目录移动文件时,来回切换和重复点击都会少很多。

WALTR PRO
WALTR PRO

WALTR是一款电脑至iOS文件传输转换工具,操作简单,快速实现文件识别与传送。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

CodeExpander
CodeExpander

CodeExpander 是一款快捷短语输入增强工具,通过键入缩写自动展开为自定义文段,提升工作效率。任务管理和过程控制会更完整,持续下载、批量同步或需要稳定传输流程的场景会更适合它。

PinStack
PinStack

PinStack是一款轻量级的Windows平台剪贴板管理工具,优化您的剪贴板使用体验。它更偏向把系统状态查看和常用调节动作放在一起,适合需要持续观察和微调设备状态的场景。

Mountain Duck
Mountain Duck

Mountain Duck 是一款能将多个网盘挂载到本地的工具,像本地磁盘一样使用网盘。清理链路的完整性会更好一些,做应用卸载、残留处理和空间整理时,通常能少走很多手动排查步骤。

Seer
Seer

Seer是一款在Win平台下的空格键功能增强效率工具,只需轻敲空格键,就能预览几乎任何格式的文件。它更适合把零散的小功能集中起来使用,处理高频琐碎任务时会更省事。