3 lines
9.5 KiB
HTML
3 lines
9.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/"/><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/5.11.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit">PkgTemplates.jl</span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../user/">User Guide</a></li><li><a class="tocitem" href="../developer/">Developer Guide</a></li><li class="is-active"><a class="tocitem" href>Migrating To PkgTemplates 0.7+</a><ul class="internal"><li><a class="tocitem" href="#Template-keywords-1"><span>Template keywords</span></a></li><li><a class="tocitem" href="#Plugins-1"><span>Plugins</span></a></li><li><a class="tocitem" href="#Package-Generation-1"><span>Package Generation</span></a></li><li><a class="tocitem" href="#Interactive-Mode-1"><span>Interactive Mode</span></a></li><li><a class="tocitem" href="#Other-Functions-1"><span>Other Functions</span></a></li><li><a class="tocitem" href="#Custom-Plugins-1"><span>Custom Plugins</span></a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Migrating To PkgTemplates 0.7+</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Migrating To PkgTemplates 0.7+</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/invenia/PkgTemplates.jl/blob/master/docs/src/migrating.md#L" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Migrating-To-PkgTemplates-0.7-1"><a class="docs-heading-anchor" href="#Migrating-To-PkgTemplates-0.7-1">Migrating To PkgTemplates 0.7+</a><a class="docs-heading-anchor-permalink" href="#Migrating-To-PkgTemplates-0.7-1" title="Permalink"></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 id="Template-keywords-1"><a class="docs-heading-anchor" href="#Template-keywords-1">Template keywords</a><a class="docs-heading-anchor-permalink" href="#Template-keywords-1" title="Permalink"></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>plugins=[!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 id="Plugins-1"><a class="docs-heading-anchor" href="#Plugins-1">Plugins</a><a class="docs-heading-anchor-permalink" href="#Plugins-1" title="Permalink"></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 id="Package-Generation-1"><a class="docs-heading-anchor" href="#Package-Generation-1">Package Generation</a><a class="docs-heading-anchor-permalink" href="#Package-Generation-1" title="Permalink"></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 id="Interactive-Mode-1"><a class="docs-heading-anchor" href="#Interactive-Mode-1">Interactive Mode</a><a class="docs-heading-anchor-permalink" href="#Interactive-Mode-1" title="Permalink"></a></h2><table><tr><th style="text-align: center">Old</th><th style="text-align: center">New</th></tr><tr><td style="text-align: center"><code>interactive_template()</code></td><td style="text-align: center"><code>Template(; interactive=true)</code></td></tr><tr><td style="text-align: center"><code>generate_interactive(pkg::AbstractString)</code></td><td style="text-align: center"><code>Template(; interactive=true)(pkg)</code></td></tr></table><h2 id="Other-Functions-1"><a class="docs-heading-anchor" href="#Other-Functions-1">Other Functions</a><a class="docs-heading-anchor-permalink" href="#Other-Functions-1" title="Permalink"></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 id="Custom-Plugins-1"><a class="docs-heading-anchor" href="#Custom-Plugins-1">Custom Plugins</a><a class="docs-heading-anchor-permalink" href="#Custom-Plugins-1" title="Permalink"></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></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../developer/">« Developer Guide</a></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Thursday 4 June 2020 15:45">Thursday 4 June 2020</span>. Using Julia version 1.4.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|