3 lines
11 KiB
HTML
3 lines
11 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Plugins · PkgTemplates.jl</title><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" action="../search.html"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../index.html">Home</a></li><li><a class="toctext" href="package_generation.html">Package Generation</a></li><li class="current"><a class="toctext" href="plugins.html">Plugins</a><ul class="internal"><li><a class="toctext" href="#TravisCI-1"><code>TravisCI</code></a></li><li><a class="toctext" href="#AppVeyor-1"><code>AppVeyor</code></a></li><li><a class="toctext" href="#GitLabCI-1"><code>GitLabCI</code></a></li><li><a class="toctext" href="#CodeCov-1"><code>CodeCov</code></a></li><li><a class="toctext" href="#Coveralls-1"><code>Coveralls</code></a></li><li><a class="toctext" href="#Documenter-1"><code>Documenter</code></a></li><li><a class="toctext" href="#GitHubPages-1"><code>GitHubPages</code></a></li></ul></li><li><a class="toctext" href="plugin_development.html">Plugin Development</a></li><li><a class="toctext" href="licenses.html">Licenses</a></li><li><a class="toctext" href="index.html">Index</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href="plugins.html">Plugins</a></li></ul><a class="edit-page" href="https://github.com/invenia/PkgTemplates.jl/blob/ca8788d2d41b2ddc27d26eba4cac02f9de09bf0d/docs/src/pages/plugins.md#L{line}"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Plugins</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="Plugins-1" href="#Plugins-1">Plugins</a></h1><p>Plugins are the driver for <code>PkgTemplates</code>'s customization and extension. This page describes plugins that already exist; for information on writing your own plugins, see <a href="plugin_development.html#Plugin-Development-1">Plugin Development</a>.</p><h2><a class="nav-anchor" id="TravisCI-1" href="#TravisCI-1"><code>TravisCI</code></a></h2><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.TravisCI" href="#PkgTemplates.TravisCI"><code>PkgTemplates.TravisCI</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">TravisCI(; config_file::Union{AbstractString, Void}="") -> TravisCI</code></pre><p>Add <code>TravisCI</code> to a template's plugins to add a <code>.travis.yml</code> configuration file to generated repositories, and an appropriate badge to the README.</p><p><strong>Keyword Arguments:</strong></p><ul><li><p><code>config_file::Union{AbstractString, Void}=""</code>: Path to a custom <code>.travis.yml</code>. If <code>nothing</code> is supplied, no file will be generated.</p></li></ul></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/ca8788d2d41b2ddc27d26eba4cac02f9de09bf0d/src/plugins/travisci.jl#LL1-L10">source</a><br/></section><h2><a class="nav-anchor" id="AppVeyor-1" href="#AppVeyor-1"><code>AppVeyor</code></a></h2><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.AppVeyor" href="#PkgTemplates.AppVeyor"><code>PkgTemplates.AppVeyor</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">AppVeyor(; config_file::Union{AbstractString, Void}="") -> AppVeyor</code></pre><p>Add <code>AppVeyor</code> to a template's plugins to add a <code>.appveyor.yml</code> configuration file to generated repositories, and an appropriate badge to the README.</p><p><strong>Keyword Arguments</strong></p><ul><li><p><code>config_file::Union{AbstractString, Void}=""</code>: Path to a custom <code>.appveyor.yml</code>. If <code>nothing</code> is supplied, no file will be generated.</p></li></ul></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/ca8788d2d41b2ddc27d26eba4cac02f9de09bf0d/src/plugins/appveyor.jl#LL1-L10">source</a><br/></section><h2><a class="nav-anchor" id="GitLabCI-1" href="#GitLabCI-1"><code>GitLabCI</code></a></h2><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.GitLabCI" href="#PkgTemplates.GitLabCI"><code>PkgTemplates.GitLabCI</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">GitLabCI(; config_file::Union{AbstractString, Void}="", coverage::Bool=true) -> GitLabCI</code></pre><p>Add <code>GitLabCI</code> to a template's plugins to add a <code>.gitlab-ci.yml</code> configuration file to generated repositories, and appropriate badge(s) to the README.</p><p><strong>Keyword Arguments:</strong></p><ul><li><p><code>config_file::Union{AbstractString, Void}=""</code>: Path to a custom <code>.gitlab-ci.yml</code>. If <code>nothing</code> is supplied, no file will be generated.</p></li><li><p><code>coverage::Bool=true</code>: Whether or not GitLab CI's built-in code coverage analysis should be enabled. If enabled, you must set a regex in your repo settings; use <code>Test Coverage (d+.d+)%</code>.</p></li></ul></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/ca8788d2d41b2ddc27d26eba4cac02f9de09bf0d/src/plugins/gitlabci.jl#LL1-L13">source</a><br/></section><h2><a class="nav-anchor" id="CodeCov-1" href="#CodeCov-1"><code>CodeCov</code></a></h2><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.CodeCov" href="#PkgTemplates.CodeCov"><code>PkgTemplates.CodeCov</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">CodeCov(; config_file::Union{AbstractString, Void}="") -> CodeCov</code></pre><p>Add <code>CodeCov</code> to a template's plugins to add a <code>.codecov.yml</code> configuration file to generated repositories, and an appropriate badge to the README. Also updates the <code>.gitignore</code> accordingly.</p><p><strong>Keyword Arguments:</strong></p><ul><li><p><code>config_file::Union{AbstractString, Void}=""</code>: Path to a custom <code>.codecov.yml</code>. If <code>nothing</code> is supplied, no file will be generated.</p></li></ul></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/ca8788d2d41b2ddc27d26eba4cac02f9de09bf0d/src/plugins/codecov.jl#LL1-L11">source</a><br/></section><h2><a class="nav-anchor" id="Coveralls-1" href="#Coveralls-1"><code>Coveralls</code></a></h2><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.Coveralls" href="#PkgTemplates.Coveralls"><code>PkgTemplates.Coveralls</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">Coveralls(; config_file::Union{AbstractString, Void}="") -> Coveralls</code></pre><p>Add <code>Coveralls</code> to a template's plugins to optionally add a <code>.coveralls.yml</code> configuration file to generated repositories, and an appropriate badge to the README. Also updates the <code>.gitignore</code> accordingly.</p><p><strong>Keyword Arguments:</strong></p><ul><li><p><code>config_file::Union{AbstractString, Void}=nothing</code>: Path to a custom <code>.coveralls.yml</code>. If left unset, no file will be generated.</p></li></ul></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/ca8788d2d41b2ddc27d26eba4cac02f9de09bf0d/src/plugins/coveralls.jl#LL1-L11">source</a><br/></section><h2><a class="nav-anchor" id="Documenter-1" href="#Documenter-1"><code>Documenter</code></a></h2><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.Documenter" href="#PkgTemplates.Documenter"><code>PkgTemplates.Documenter</code></a> — <span class="docstring-category">Type</span>.</div><div><p>Add a <code>Documenter</code> subtype to a template's plugins to add support for documentation generation via <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a>.</p></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/ca8788d2d41b2ddc27d26eba4cac02f9de09bf0d/src/plugins/documenter.jl#LL1-L4">source</a><br/></section><h2><a class="nav-anchor" id="GitHubPages-1" href="#GitHubPages-1"><code>GitHubPages</code></a></h2><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="PkgTemplates.GitHubPages" href="#PkgTemplates.GitHubPages"><code>PkgTemplates.GitHubPages</code></a> — <span class="docstring-category">Type</span>.</div><div><pre><code class="language-none">GitHubPages(; assets::Vector{<:AbstractString}=String[]) -> GitHubPages</code></pre><p>Add <code>GitHubPages</code> to a template's plugins to add <a href="plugins.html#Documenter-1">Documenter</a> support via GitHub Pages, including automatic uploading of documentation from <a href="plugins.html#PkgTemplates.TravisCI"><code>TravisCI</code></a>. Also adds appropriate badges to the README, and updates the <code>.gitignore</code> accordingly.</p><p><strong>Keyword Arguments</strong></p><ul><li><p><code>assets::Vector{String}=String[]</code>: Array of paths to Documenter asset files.</p></li></ul></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/ca8788d2d41b2ddc27d26eba4cac02f9de09bf0d/src/plugins/githubpages.jl#LL1-L10">source</a><br/></section><footer><hr/><a class="previous" href="package_generation.html"><span class="direction">Previous</span><span class="title">Package Generation</span></a><a class="next" href="plugin_development.html"><span class="direction">Next</span><span class="title">Plugin Development</span></a></footer></article></body></html>
|