Edit on GitHub

DevEnvConfig

Pulic repo of DevEnvConfig.

Early release for registration. Do not use.

Conventions

We use TypeName|∅ to denote the type Union{TypeName, Nothing}

const ∅ = Nothing
Base.:|(::Type{A},::Type{B}) where {A,B} = Union{A,B}

Exported API

DevEnvConfig.newpkg — Function
function newpkg(pkname::String;
    dir             :: String|∅ = nothing,
    docrepo         :: String|∅ = nothing,
    private         :: Bool     = false,
    useextjl        :: Bool|∅   = nothing,
    generalregistry :: Bool|∅   = nothing,
    license         :: String|∅ = nothing) -> ActionStatus

Create a new package. This will use your GitHub account to:

  • setup documentation generation and deployment,
  • setup unit testing and badge status,
  • setup code coverage on CodeCov and badge statu

This template handles private package repo, with doc deployment in another (public) repo. Also provides guided setup for code coverage reporting for private repo.

Arguments

  • pkname: the name of the new Julia Package
  • dir: the directory is which to create the package, defaul to JULIA_PKG_DEVDIR
  • docrepo: the name of a GitHub repo used to publish the documentation, default to the package repo.
  • private: set to true is this package is hosted in a private GitHub repository
  • useextjl: set to true if the GitHub repository is named PackageName.jl, default to !private
  • generalregistry: set to true if this package will be registered in General, default to !private
  • license: name of the LICENSE file, default to MIT for public package
source