TastyPancakes/PkgTemplates.jl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add CirrusCI to docs and add plugin overview section

Browse Source
This commit is contained in:
Chris de Graaf 2019-01-03 11:47:57 -06:00 committed by Chris de Graaf
parent 192caf818e
commit 4468d1b782
3 changed files with 35 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -15,6 +15,22 @@ repeatable, and customizable way.**
pkg> add PkgTemplates pkg> add PkgTemplates
``` ```
## Plugins
`PkgTemplates` is based on plugins which handle the setup of individual package components.
The available plugins are:
* Continuous Integration (CI)
* [Travis CI](https://travis-ci.com) (Linux, MacOS)
* [AppVeyor](https://appveyor.com) (Windows)
* [GitLabCI](https://gitlab.com) (Linux)
* [CirrusCI](https://cirrus-ci.org) (FreeBSD)
* Code Coverage
* [Codecov](https://codecov.io)
* [Coveralls](https://coveralls.io)
* Documentation
* [GitHubPages](https://pages.github.com)
## Usage ## Usage
Assuming you have the relatively standard Git options `user.name`, `user.email` and `github.user` set up globally with `git config --global`, the simplest template requires no arguments: Assuming you have the relatively standard Git options `user.name`, `user.email` and `github.user` set up globally with `git config --global`, the simplest template requires no arguments:
@ -61,6 +77,7 @@ julia> t = Template(;
Coveralls(), Coveralls(),
AppVeyor(), AppVeyor(),
GitHubPages(), GitHubPages(),
CirrusCI(),
], ],
) )
Template: Template:

17
docs/src/index.md
View File

@ -15,6 +15,22 @@ repeatable, and customizable way.**
pkg> add PkgTemplates pkg> add PkgTemplates
``` ```
## Plugins
`PkgTemplates` is based on plugins which handle the setup of individual package components.
The available plugins are:
* Continuous Integration (CI)
* [Travis CI](https://travis-ci.com) (Linux, MacOS)
* [AppVeyor](https://appveyor.com) (Windows)
* [GitLabCI](https://gitlab.com) (Linux)
* [CirrusCI](https://cirrus-ci.org) (FreeBSD)
* Code Coverage
* [Codecov](https://codecov.io)
* [Coveralls](https://coveralls.io)
* Documentation
* [GitHubPages](https://pages.github.com)
## Usage ## Usage
```@setup usage ```@setup usage
@ -56,6 +72,7 @@ t = Template(;
Coveralls(), Coveralls(),
AppVeyor(), AppVeyor(),
GitHubPages(), GitHubPages(),
CirrusCI(),
], ],
) )
generate("MyPkg2", t) generate("MyPkg2", t)

1
docs/src/pages/plugins.md
View File

@ -14,6 +14,7 @@ describes plugins that already exist; for information on writing your own plugin
TravisCI TravisCI
AppVeyor AppVeyor
GitLabCI GitLabCI
CirrusCI
``` ```
## Code Coverage ## Code Coverage