如何将插件添加到WordPress存储库?


11

我刚刚制作了第一个插件,并且得到了WordPress的批准。对我来说是个好消息,但是现在呢?法典上的“指示”对我来说一点都不清晰。我确实找到了有关Dig WP的文章,并设法到达了第三行代码。在那之后没有喜悦。

这里有人在不需要阅读整本书的情况下就如何执行此操作提供了清晰的说明吗?我敢肯定,这里有非常有经验的人总是在做这些事情。

提前致谢!



@Piet:如果Bainternet在下面的答案中提到的链接没有回答您的问题,我们需要知道您使用的是哪种OS&svn工具。
Manzabar 2011年

是的,我应该提到我在OSX 10.6(Mac)上。另外,非常高兴地指导我完成如何编写readme.txt文件的步骤,但由于插件已被WordPress.org批准,因此没有必要。现在,我假设只有在readme.txt文件通过验证后才能批准,通过这种方式:)

我从官方网站(?)下载了SVN,但是我不知道它如何工作以及我应该怎么做。正如我提到的,我遵循了DIG WP的教程,并设法完成了前3行,然后程序停止了对我的处理。名称为 my-local-dir $ cd my-local-dir /)

实际上,应用程序与自述文件无关。在开始开发插件之前,我经常申请(并获得批准)。
EAMann

Answers:


12

步骤1-确保事物格式正确

WordPress本身取决于主插件文件顶部的标头。在许多情况下,如果您的插件是“我的酷插件”,则此文件my-cool-plugin.php位于文件夹的主目录中。确保文件的顶部遵循以下格式:

<?php
/*
=== [Plugin Name] ===

Plugin Name: [Plugin name]
Plugin URI: [Website where plugin information can be found - your blog, maybe]
Description: [Short description of your plugin]
Author URI: [Your website]
Author: [Your name]
Version: [This version number]
*/

WordPress.org存储库取决于您的readme.txt文件以创建描述和下载页面。因此,请确保您的readme.txt文件适合以下格式:

=== [Plugin Name] ===
Contributors: [Your WordPress.org username]
Donate link: [A site people can go to to give you money]
Tags: [Search terms related to your plugin]
Requires at least: [Minimum version of WordPress required]
Tested up to: [Newest version of WordPress you've tested with]
Stable tag: [This version number]

[Short, one-sentence description of your plugin]

== Description ==

[Long description of your plugin]

== Installation ==

[Steps required to install the plugin]

== Frequently Asked Questions ==

= [A question] =

[An answer]

= [Another question] =

[Another answer]

== Screenshots ==

== Changelog ==

== Upgrade Notice ==

WordPress.org上有一个方便的自述文件验证器,您可以用来确保自述文件具有所需的一切。只需复制粘贴,它将检查以确保所有部分都在其中并且您已准备就绪。

第2步-签出SVN存储库

将开发版本与WordPress.org插件存储库分开是一个好主意。是的,SVN用于版本控制,但WordPress将其更多地用于版本管理。如果开始将每个变更集提交到存储库,则可能会遇到问题。许多开发人员要做的一件事是使用Git在本地进行开发,然后在准备发布时将文件传输到Subversion存储库中。

这些说明假定您使用的是Windows计算机。如果您使用的是Mac,则可以使用SCPlugin代替TortoiseSVN。您需要遵循的步骤将是相同的,只是由于UI,上下文菜单和屏幕截图会略有不同。我没有Mac,因此无法创建屏幕截图以引导您完成教程……但是请相信我,这是相同的过程。

如果尚未安装TortoiseSVN,请安装它。

TortoiseSVN是Windows的开源Subversion GUI。相信我,使用GUI比尝试从命令行执行操作要容易得多。您也会遇到更少的问题。

查看您的WordPress托管的SVN存储库

查找您要存储WordPress托管版本的插件的位置。默认情况下,我/My Documents/WordPress/用于所有托管的开发工作。在文件夹内右键单击,然后从下拉菜单中选择“ SVN Checkout”。

TortoiseSVN上下文菜单

在弹出的对话框窗口中,输入WordPress.org插件存储库URL(出于演示目的,我正在使用我的其中一个),然后选择要创建的子文件夹。

检出对话框

Tortoise会考虑一下,然后将其从WordPress.org中删除。新创建的文件夹将为您设置所有必需的文件夹。现在,您只需复制粘贴并提交...一次即可。

将最新版本复制到 /tags

这是我从大多数教程开始往后看的地方。其他所有人都会告诉您先提交/trunk,但是请记住,/trunk在查看插件时,WordPress 除了自述文件外不使用任何东西。因此,如果/trunk在提交标签之前将插件放入并失去网络连接(或其他问题),则会遇到问题。

在该/tags文件夹中,创建一个名称与要为插件发布的版本相同的文件夹。因此,如果要发布版本0.1,请创建一个/tags/0.1文件夹。

存储库标签文件夹

将整个插件复制到此文件夹中。

现在,在文件夹内右键单击,然后从下拉菜单中选择“ SVN Commit”。

您会看到一个弹出窗口,显示所有更改(您应该看到所有新文件都标记为“非版本”)。

提交窗口

选中所有插件文件旁边的框(或单击“全选”以选择所有文件)。

在顶部的框中,输入提交消息。由于您要提交标签,因此您可能应该使用类似以下的内容:

标记[My Plugin]的版本0.1。

单击确定。

同样,Tortoise将思考几分钟,然后将要求您提供WordPress用户名和密码以提交到服务器。提供给他们,等待事情解决,说出“成功”,然后继续下一步。

将最新版本复制到 /trunk

现在,导航到/trunk存储库的文件夹,然后再次将插件复制粘贴到该文件夹​​。完成上述相同步骤,选择文件并准备提交。但是要获得消息,请使用一些说明新版本功能的内容:

[我的插件]的0.1版-添加了对OpenID的支持。

一旦一切顺利,您只需等待WordPress.org的服务器赶上。他们有时可能比其他人要慢一些,但是在一小时内,您应该会在存储库中看到新版本。

将插件更新到新版本

插件发布后,准备更新相对容易。

首先,使用SVN Update命令来确保您拥有最新版本的存储库。如果您是唯一的开发人员,那么您应该已经这样做了,但是最好还是在提交之前进行更新。

然后,通过上述过程/tags为您的新版本创建一个新的子文件夹。说,/tags/0.2。不要触摸旧/0.1文件夹。它在那里是有原因的,您将再也不会碰它。

提交新标签,然后转到/trunk文件夹。/trunk用您的新版本替换其中的所有内容,然后如上所述进行提交。服务器更新后,他们将开始谈论新版本,而不是旧版本。


1
我更喜欢从树干开始做所有事情,因为它使我可以很好地了解每条线的来源。使用您的方法,不是看起来一切都像最新版本一样吗?
Jan Fabry

非常感谢@EAMann的详细说明。不幸的是,我在Mac上,对不起,我应该在我的问题中提到我的糟糕...

1
@Jan这就是原因,我把我的发展回购单独从我发布回购。使用WP.org仓库进行主动开发时,我已经彻底搞砸了,因此我使用Git或Hg在本地进行开发以获取完整的版本历史记录,然后在构建发行版时将其复制到WP Svn仓库中。
EAMann

@Piet在这种情况下,请查看适用于Mac的SCPlugin。说明将完全相同,仅屏幕截图有所不同。它是由许多相同的人制造的,因此其功能就像Tortoise。
EAMann

@EAMann谢谢,我现在正在下载它,它将让您知道它的运行情况
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.