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" 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="../package_generation/">Package Generation</a></li><li class="current"><a class="toctext" href>Plugins</a><ul class="internal"><li><a class="toctext" href="#Continuous-Integration-(CI)-1">Continuous Integration (CI)</a></li><li><a class="toctext" href="#Code-Coverage-1">Code Coverage</a></li><li><a class="toctext" href="#Documentation-1">Documentation</a></li></ul></li><li><a class="toctext" href="../plugin_development/">Plugin Development</a></li><li><a class="toctext" href="../licenses/">Licenses</a></li><li><a class="toctext" href="../">Index</a></li></ul></nav><article id="docs"><header><nav><ul><li><a href>Plugins</a></li></ul><a class="edit-page" href="https://github.com/invenia/PkgTemplates.jl/blob/master/docs/src/pages/plugins.md#L"><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 secret sauce behind <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/#Plugin-Development-1">Plugin Development</a>.</p><h2><a class="nav-anchor" id="Continuous-Integration-(CI)-1" href="#Continuous-Integration-(CI)-1">Continuous Integration (CI)</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><div><pre><code class="language-none">TravisCI(; config_file::Union{AbstractString, Nothing}="") -> 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><code>config_file::Union{AbstractString, Nothing}=""</code>: Path to a custom <code>.travis.yml</code>. If <code>nothing</code> is supplied, no file will be generated.</li></ul></div></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/099e826241fca365a120df9bac9a9fede6e7bae4/base/#L0-L9">source</a></section><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><div><pre><code class="language-none">AppVeyor(; config_file::Union{AbstractString, Nothing}="") -> 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><code>config_file::Union{AbstractString, Nothing}=""</code>: Path to a custom <code>.appveyor.yml</code>. If <code>nothing</code> is supplied, no file will be generated.</li></ul></div></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/099e826241fca365a120df9bac9a9fede6e7bae4/base/#L0-L9">source</a></section><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><div><pre><code class="language-none">GitLabCI(; config_file::Union{AbstractString, Nothing}="", 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><code>config_file::Union{AbstractString, Nothing}=""</code>: Path to a custom <code>.gitlab-ci.yml</code>. If <code>nothing</code> is supplied, no file will be generated.</li><li><code>coverage::Bool=true</code>: Whether or not GitLab CI's built-in code coverage analysis should be enabled.</li></ul></div></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/099e826241fca365a120df9bac9a9fede6e7bae4/base/#L0-L11">source</a></section><h2><a class="nav-anchor" id="Code-Coverage-1" href="#Code-Coverage-1">Code Coverage</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><div><pre><code class="language-none">Codecov(; config_file::Union{AbstractString, Nothing}=nothing) -> Codecov</code></pre><p>Add <code>Codecov</code> to a template's plugins to optionally 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><code>config_file::Union{AbstractString, Nothing}=nothing</code>: Path to a custom <code>.codecov.yml</code>. If left unset, no file will be generated.</li></ul></div></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/099e826241fca365a120df9bac9a9fede6e7bae4/base/#L0-L10">source</a></section><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><div><pre><code class="language-none">Coveralls(; config_file::Union{AbstractString, Nothing}=nothing) -> 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><code>config_file::Union{AbstractString, Nothing}=nothing</code>: Path to a custom <code>.coveralls.yml</code>. If left unset, no file will be generated.</li></ul></div></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/099e826241fca365a120df9bac9a9fede6e7bae4/base/#L0-L10">source</a></section><h2><a class="nav-anchor" id="Documentation-1" href="#Documentation-1">Documentation</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><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><p>By default, the plugin generates a minimal index.md and a make.jl file. The make.jl file contains the Documenter.makedocs command with predefined values for <code>modules</code>, <code>format</code>, <code>pages</code>, <code>repo</code>, <code>sitename</code>, and <code>authors</code>.</p><p>The subtype is expected to include the following fields:</p><ul><li><code>assets::Vector{AbstractString}</code>, a list of filenames to be included as the <code>assets</code></li></ul><p>kwarg to <code>makedocs</code></p><ul><li><code>gitignore::Vector{AbstractString}</code>, a list of files to be added to the <code>.gitignore</code></li></ul><p>It may optionally include the field <code>additional_kwargs::Union{AbstractDict, NamedTuple}</code> to allow additional kwargs to be added to <code>makedocs</code>.</p></div></div><a class="source-link" target="_blank" href="https://github.com/invenia/PkgTemplates.jl/blob/f3761d54580f9c2389d838baf895948284268a99/src/plugins/documenter.jl#LL4-L19">source</a></section><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><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="#PkgTemplates.Documenter"><code>Documenter</code></a> support via GitHub Pages, including automatic uploading of documentation from <a href="#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><code>assets::Vector{<:AbstractString}=String[]</code>: Array of paths to Documenter asset files.</li></ul><div class="admonition note"><div class="admonition-title">Note</div><div class="admonition-text"><p>If deploying documentation with Travis CI, don't forget to complete the required configuration (see <a href="https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#SSH-Deploy-Keys-1">here</a>).</p></div></div></div></div><a class="source-link" target="_blank" href="https://github.com/JuliaLang/julia/blob/099e826241fca365a120df9bac9a9fede6e7bae4/base/#L0-L14">source</a></section><footer><hr/><a class="previous" href="../package_generation/"><span class="direction">Previous</span><span class="title">Package Generation</span></a><a class="next" href="../plugin_development/"><span class="direction">Next</span><span class="title">Plugin Development</span></a></footer></article></body></html>
|