Skip to content

Commit 1374fad

Browse files
committed
Added basic notes for publishing a plugin.
1 parent a97ffeb commit 1374fad

File tree

2 files changed

+33
-7
lines changed

2 files changed

+33
-7
lines changed

grunt.js

+2-7
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,6 @@ grunt.registerTask( "clean", function() {
6666
rimraf.sync( "retry.db" );
6767
});
6868

69-
grunt.registerTask( "setup-wordpress", function() {
70-
// TODO: setup post-receive hook
71-
72-
grunt.task.run( "docs" );
73-
});
74-
7569
grunt.registerTask( "setup-pluginsdb", function() {
7670
var done = this.async();
7771
require( "./lib/pluginsdb" )._setup(function( error ) {
@@ -113,7 +107,8 @@ grunt.registerTask( "restore-repos", function() {
113107
});
114108

115109
grunt.registerTask( "default", "lint test" );
116-
grunt.registerTask( "setup", "setup-pluginsdb setup-retrydb setup-wordpress" );
110+
grunt.registerTask( "setup", "setup-pluginsdb setup-retrydb docs" );
111+
grunt.registerTask( "update", "docs" );
117112
grunt.registerTask( "restore", "clean setup-retrydb docs restore-repos" );
118113

119114
};

site-content/page/docs/publish.html

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<script>{
2+
"title": "Publishing Your Plugin"
3+
}</script>
4+
5+
<p>Publishing your plugin on this site is a simple two step process.</p>
6+
7+
<h2>Post-Receive Hook</h2>
8+
9+
<p>First, you'll need to create a post-receive hook on GitHub. Just follow the
10+
<a href="https://help.github.com/articles/post-receive-hooks">step-by-step guide
11+
for adding a webhook</a> and set the URL to
12+
<code>http://plugins.jquery.com/update-hook</code>. Now you're ready to publish
13+
your plugin.</p>
14+
15+
<h2>Publishing a Version</h2>
16+
17+
<p>Once the post-receive hook is setup, publishing your plugin is as simple as
18+
tagging the version in git and pushing the tag to GitHub. The post-receive hook
19+
will notify the plugins site that a new tag is available and the plugins site
20+
will take care of the rest!</p>
21+
22+
<p>The name of the tag <strong>must</strong> be a valid
23+
<a href="http://semver.org/">semver</a> value. The tag name may contain an
24+
optional <code>v</code> prefix. The tag name must also match the version listed
25+
in the manifest file. If the manifest file is valid, then the version will be
26+
automatically added to the plugins site.</p>
27+
28+
<p>Unfortunately we do not currently have a system for notifying you if there is
29+
a problem. If you're interested in helping improve this aspect of the plugins
30+
site, we'd <a href="https://github.com/jquery/plugins.jquery.com/issues/11">love
31+
your help</a>.</p>

0 commit comments

Comments
 (0)