| Index: app/views/doc/pub-lish.html
|
| diff --git a/app/views/doc/pub-lish.html b/app/views/doc/pub-lish.html
|
| deleted file mode 100644
|
| index 173722616b106b285d20c743ab9dbcd56fac60e1..0000000000000000000000000000000000000000
|
| --- a/app/views/doc/pub-lish.html
|
| +++ /dev/null
|
| @@ -1,93 +0,0 @@
|
| -<pre><code>$ pub publish [--dry-run] [--force] [--server <url>]
|
| -</code></pre>
|
| -
|
| -<p>This command publishes your package on
|
| -<a href="http://pub.dartlang.org">pub.dartlang.org</a> for anyone to download and depend
|
| -on. For example, if your package is named transmogrify, it will be listed on
|
| -<code>http://pub.dartlang.org/packages/transmogify</code>, and users can depend on it in
|
| -their pubspecs and get it via <a href="pub-get.html">pub get</a> using something
|
| -like:</p>
|
| -
|
| -<div class="highlight"><pre><code class="dart"><span class="nl">dependencies:</span>
|
| - <span class="nl">transmogrify:</span> <span class="s2">">= 1.0.0 < 2.0.0"</span>
|
| -</code></pre></div>
|
| -
|
| -<p>When publishing a package, it’s important to follow the <a href="pubspec.html">pubspec
|
| -format</a> and <a href="package-layout.html">package layout conventions</a>.
|
| -Some of these are required in order for others to be able to use your package.
|
| -Others are suggestions to help make it easier for users to understand and work
|
| -with your package. In both cases, pub will try to help you by pointing out what
|
| -changes will help make your package play nicer with the Dart ecosystem. There
|
| -are a few additional requirements for uploading a package:</p>
|
| -
|
| -<ul>
|
| - <li>
|
| - <p>You must include a license file (named <code>LICENSE</code>, <code>COPYING</code>, or some
|
| -variation) that contains an <a href="http://opensource.org/">open-source license</a>. We
|
| -recommend the <a href="http://opensource.org/licenses/BSD-2-Clause">BSD license</a>,
|
| -which is used by Dart itself. You must also have the legal right to
|
| -redistribute anything that you upload as part of your package.</p>
|
| - </li>
|
| - <li>
|
| - <p>Your package must be less than ten megabytes large after gzip compression. If
|
| -it’s too large, consider splitting it into multiple packages, or cutting down
|
| -on the number of included resources or examples.</p>
|
| - </li>
|
| - <li>
|
| - <p>Your package should only have hosted dependencies. Git dependencies are
|
| -allowed but strongly discouraged; not everyone using Dart has Git installed,
|
| -and Git dependencies don’t support version resolution as well as hosted
|
| -dependencies do.</p>
|
| - </li>
|
| -</ul>
|
| -
|
| -<p>Be aware that the email address associated with your Google account will be
|
| -displayed on <a href="http://pub.dartlang.org">pub.dartlang.org</a> along with any packages
|
| -you upload.</p>
|
| -
|
| -<h2 id="what-files-are-published">What files are published?</h2>
|
| -
|
| -<p><strong>All files</strong> in your package will be included in the published package, with
|
| -the following exceptions:</p>
|
| -
|
| -<ul>
|
| - <li>Any <code>packages</code> directories.</li>
|
| - <li>Your package’s <a href="glossary.html#lockfile">lockfile</a>.</li>
|
| - <li>If you’re using Git, any files ignored by your <code>.gitignore</code> file.</li>
|
| - <li>If you aren’t using Git, all “hidden” files (that is, files whose names begin
|
| -with <code>.</code>).</li>
|
| -</ul>
|
| -
|
| -<p>If there are other files you don’t want to include, be sure to delete them (or
|
| -add them to <code>.gitignore</code>) before running <code>pub publish</code>.</p>
|
| -
|
| -<p>To be on the safe side, <code>pub publish</code> will list all files it’s going to publish
|
| -for you to look over before it actually uploads your package.</p>
|
| -
|
| -<h2 id="options">Options</h2>
|
| -
|
| -<h3 id="dry-run-or--n"><code>--dry-run</code> or <code>-n</code></h3>
|
| -
|
| -<p>With this, pub goes through the validation process but does not actually upload
|
| -the package. This is useful if you want to see if your package meets all of the
|
| -publishing requirements before you’re ready to actually go public.</p>
|
| -
|
| -<h3 id="force-or--f"><code>--force</code> or <code>-f</code></h3>
|
| -
|
| -<p>With this, pub does not ask for confirmation before publishing. Normally, it
|
| -shows you the package contents and asks for you to confirm the upload.</p>
|
| -
|
| -<p>If there are any errors in your package, it is not uploaded and this exits with
|
| -an error. If there are warnings, it <em>will</em> be uploaded. If you want to ensure
|
| -your package has no warnings before uploading, either don’t use <code>--force</code>, or
|
| -use <code>--dry-run</code> first.</p>
|
| -
|
| -<h3 id="server"><code>--server</code></h3>
|
| -
|
| -<p>If you pass <code>--server</code> followed by a URL, it will attempt to publish the
|
| -package to that server. It assumes the server supports the same HTTP API that
|
| -<a href="http://pub.dartlang.org">pub.dartlang.org</a> uses.</p>
|
| -
|
| -<p>This can be useful if you’re running your own local package server for testing.
|
| -The main pub server is itself open source and available <a href="https://github.com/dart-lang/pub-dartlang">here</a>.</p>
|
| -
|
|
|