30 days ago
PkgDev.jl provides a set of tools for a developer to create, maintain and register packages in Julia package repository, a.k.a. METADATA.
For closer integration with GitHub API, PkgDev.jl requires
curl to be installed.
pkg at the git URL
url, defaulting to the configured origin URL of the git repository
commit as version
ver of package
pkg and create a version entry in
METADATA. If not provided,
commit defaults to the current commit of the
pkg repository. If
ver is one of the symbols
:major the next patch, minor or major version is used. If
ver is not provided, it defaults to
You are strongly encouraged to update the version numbers in accordance with the semver standard:
tag(pkg, :major)when you make backwards-incompatible API changes (i.e. changes that will break existing user code).
tag(pkg, :minor)when you add functionality in a backwards-compatible way (i.e. existing user code will still work, but code using the new functionality will not work with older versions of your package).
tag(pkg, :patch)when you make bug fixes and other improvements that don't change the API (i.e. user code is unchanged). The key question is not how "small" the change is, but how it affects the API and user code. (Don't be reluctant to bump the minor version when you add new features to the API, no matter how trivial — version numbers are cheap!)
If you drop support for an older version of Julia, you should make at least a minor version bump even if there were no API changes.
For each new package version tagged in
METADATA not already published, make sure that the tagged package commits have been pushed to the repository at the registered URL for the package and if they all have, open a pull request to
Generate a new package named
pkg with one of the bundled license:
"LGPL-3.0+". If you want to make a package with a different license, you can edit it afterwards. Generate creates a git repository at
Pkg.dir(pkg) for the package and inside it
REQUIRE, the julia entrypoint
$pkg/src/$pkg.jl, and Travis and AppVeyor CI configuration files
Warning: If you release code for Package X under the GPL, you may discourage collaboration from members of the Julia community who work on non-GPL packages. For example, if a user works on Package Y, which is licensed under the MIT license that is used in many community projects, other developers might not feel safe to read the code you contribute to Package Y because any indication that their work is derivative could lead to litigation. In effect, you create a situation in which your source code is percieved as being closed to anyone who is working on a non-GPL project.
path- a location where the package will be generated, the default location is
travis- enables generation of the
.travis.ymlconfiguration for Travis CI service, the default value is
appveyor- enables generation of the
appveyor.ymlconfiguration for Appveyor service, the default value is
coverage- enables generation of a code coverage reporting to Coveralls and Codecov services, default value is
List all bundled licenses. If a license label specified as a parameter then a full text of the license will be printed.
Returns a list of packages which are good candidates for
Pkg.free. These are packages for which you are not tracking the
tagged release, but for which a tagged release is equivalent to the
current version. You can use
automatically free all such packages.
This also prints (to
io, defaulting to standard output) a list of
packages that are ahead of a tagged release, and prints the number of
commits that separate them. It can help discover packages that may be
due for tagging.