3 lines
6.5 KiB
HTML
3 lines
6.5 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Migrating To PkgTemplates 0.7+ · PkgTemplates.jl</title><link rel="canonical" href="https://invenia.github.io/PkgTemplates.jl/migrating/index.html"/><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link href="../assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>PkgTemplates.jl</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" id="search-form" action="../search/"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../">Home</a></li><li><a class="toctext" href="../user/">User Guide</a></li><li><a class="toctext" href="../developer/">Developer Guide</a></li><li class="current"><a class="toctext" href>Migrating To PkgTemplates 0.7+</a><ul class="internal"><li><a class="toctext" href="#Template-keywords-1">Template keywords</a></li><li><a class="toctext" href="#Plugins-1">Plugins</a></li><li><a class="toctext" href="#Package-Generation-1">Package Generation</a></li><li><a class="toctext" href="#Interactive-Templates-1">Interactive Templates</a></li><li><a class="toctext" href="#Other-Functions-1">Other Functions</a></li><li><a class="toctext" href="#Custom-Plugins-1">Custom Plugins</a></li></ul></li></ul></nav><article id="docs"><header><nav><ul><li><a href>Migrating To PkgTemplates 0.7+</a></li></ul><a class="edit-page" href="https://github.com/invenia/PkgTemplates.jl/blob/master/docs/src/migrating.md#L"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Migrating To PkgTemplates 0.7+</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="Migrating-To-PkgTemplates-0.7-1" href="#Migrating-To-PkgTemplates-0.7-1">Migrating To PkgTemplates 0.7+</a></h1><p>PkgTemplates 0.7 is a ground-up rewrite of the package with similar functionality but with updated APIs and internals. Here is a summary of things that existed in older versions but have been moved elsewhere or removed. However, it might be easier to just read the <a href="../user/">User Guide</a>.</p><h2><a class="nav-anchor" id="Template-keywords-1" href="#Template-keywords-1">Template keywords</a></h2><p>The recurring theme is "everything is a plugin now".</p><table><tr><th style="text-align: center">Old</th><th style="text-align: center">New</th></tr><tr><td style="text-align: center"><code>license="ISC"</code></td><td style="text-align: center"><code>plugins=[License(; name="ISC")]</code></td></tr><tr><td style="text-align: center"><code>develop=true</code> *</td><td style="text-align: center"><code>plugins=[Develop()]</code></td></tr><tr><td style="text-align: center"><code>git=false</code></td><td style="text-align: center"><code>disable_defaults=[Git]</code></td></tr><tr><td style="text-align: center"><code>julia_version=v"1"</code></td><td style="text-align: center"><code>julia=v"1"</code></td></tr><tr><td style="text-align: center"><code>ssh=true</code></td><td style="text-align: center"><code>plugins=[Git(; ssh=true)]</code></td></tr><tr><td style="text-align: center"><code>manifest=true</code></td><td style="text-align: center"><code>plugins=[Git(; manifest=true)]</code></td></tr></table><p>* <code>develop=true</code> was the default setting, but it is no longer the default in PkgTemplates 0.7+.</p><h2><a class="nav-anchor" id="Plugins-1" href="#Plugins-1">Plugins</a></h2><p>Aside from renamings, basically every plugin has had their constructors reworked. So if you are using anything non-default, you should consult the new docstring.</p><table><tr><th style="text-align: center">Old</th><th style="text-align: center">New</th></tr><tr><td style="text-align: center"><code>GitHubPages</code></td><td style="text-align: center"><code>Documenter{TravisCI}</code></td></tr><tr><td style="text-align: center"><code>GitLabPages</code></td><td style="text-align: center"><code>Documenter{GitLabCI}</code></td></tr></table><h2><a class="nav-anchor" id="Package-Generation-1" href="#Package-Generation-1">Package Generation</a></h2><p>One less name to remember!</p><table><tr><th style="text-align: center">Old</th><th style="text-align: center">New</th></tr><tr><td style="text-align: center"><code>generate(::Template, pkg::AbstractString)</code></td><td style="text-align: center"><code>(::Template)(pkg::AbstractString)</code></td></tr></table><h2><a class="nav-anchor" id="Interactive-Templates-1" href="#Interactive-Templates-1">Interactive Templates</a></h2><p>Currently not implemented, but will be in the future.</p><h2><a class="nav-anchor" id="Other-Functions-1" href="#Other-Functions-1">Other Functions</a></h2><p>Two less names to remember! Although it's unlikely that anyone used these.</p><table><tr><th style="text-align: center">Old</th><th style="text-align: center">New</th></tr><tr><td style="text-align: center"><code>available_licenses</code></td><td style="text-align: center"><a href="https://github.com/invenia/PkgTemplates.jl/tree/master/templates/licenses">View licenses on GitHub</a></td></tr><tr><td style="text-align: center"><code>show_license</code></td><td style="text-align: center"><a href="https://github.com/invenia/PkgTemplates.jl/tree/master/templates/licenses">View licenses on GitHub</a></td></tr></table><h2><a class="nav-anchor" id="Custom-Plugins-1" href="#Custom-Plugins-1">Custom Plugins</a></h2><p>In addition to the changes in usage, custom plugins from older versions of PkgTemplates will not work in 0.7+. See the <a href="../developer/">Developer Guide</a> for more information on the new extension API.</p><footer><hr/><a class="previous" href="../developer/"><span class="direction">Previous</span><span class="title">Developer Guide</span></a></footer></article></body></html>
|