dlfivefifty / Registrator.jl

Julia package registration bot

Registrator

Registrator is a GitHub app that automates creation of registration pull requests for your julia packages to the General registry. Install the app below!

Install Registrator:

How to Use

First, install the app on your package(s) as mentioned above. The procedure for registering a new package is the same as for releasing a new version.

Registrator will look for the project file in the master branch by default. To use a custom branch comment with:

@JuliaRegistrator register(branch=name-of-your-branch)

If you are a collaborator on the repo

Either:

1. Open an issue and add @JuliaRegistrator register() as a comment. You can re-trigger the registrator by commenting @JuliaRegistrator register() again (in case registrator reports an error or you wish to make changes).
2. Add a comment to a commit and say @JuliaRegistrator register().

If you are not a collaborator

You can request a collaborator trigger registrator in a GitHub issue or a comment on a commit.

Approving pull requests on the registry

Currently, a registry maintainer will manually merge the pull request made by Registrator. We will soon have a CI system to check and auto-merge without human intervention.

Note on git tags and GitHub releases

The Julia package manager does not rely on git tags and GitHub releases. However, Registrator will generate a git tag command for you to optionally create a corresponding tag with your package version.