Registrator is a GitHub app that automates creation of registration pull requests for your julia packages to the General registry. Install the app below!
Note: if you are registering a new package or new version in the General registry, please make sure that you have read the General registry README.
Click on the "install" button above to add the registration bot to your repository
How to Use
There are two ways to use Registrator: a web interface and a GitHub app.
Via the Web Interface
This workflow supports repositories hosted on either GitHub or GitLab.
Via the GitHub App
Unsurprisingly, this method only works for packages whose repositories are hosted on GitHub.
The procedure for registering a new package is the same as for releasing a new version.
If the registration bot is not added to the repository,
@JuliaRegistrator register will not result in package registration.
- Click on the "install" button above to add the registration bot to your repository
- Set the
(Julia)Project.tomlversion field in your repository to your new desired
@JuliaRegistrator registeron the commit/branch you want to register (e.g. like here or here).
- If something is incorrect, adjust, and redo step 2.
- If the automatic tests pass, but a moderator makes suggestions (e.g., manually updating your
(Julia)Project.tomlto include a [compat] section with version requirements for dependencies), then incorporate suggestions as you see fit into a new commit, and redo step 2 for the new commit. You don't need to do anything to close out the old request.
- Finally, either rely on the TagBot GitHub Action to tag and make a github release or alternatively tag the release manually.
Registrator will look for the project file in the master branch by default, and will use the version set in the
(Julia)Project.toml file via, for example,
version = "0.1.0". To use a custom branch comment with:
@JuliaRegistrator register branch=name-of-your-branch
The old pseudo-Julia syntax is also still supported:
Triggering New Releases from the Main Branch Via the GitHub App
If TagBot has been installed as above, and the initial package registration is complete, new versions can be tagged directly on your repository. The simplest way to trigger a change is to
- Increment the
version = "X.X.X"line in the
Project.tomlfile of your package, and merge that commit to the main branch.
- Open that commit on github and add in a comment with
@JuliaRegistrator register. TagBot will respond with a comment on that same commit.
If that operation is successful, a new version will be tagged and merged automatically in the general registry within approximately 15 minutes.
Transitioning from REQUIRE to Project.toml
Download gen_project.jl, enter in your package directory and run
julia gen_project.jl, resulting in a
Project.toml file. You may need to do minor modifications (license, current version, description, etc.) and then remove the REQUIRE file, since it is only used for packages supporting Julia 0.6 and is otherwise irrelevant now.
Check that your package conforms to the required
Project.toml structure found in the general package guidelines.
Details for triggering JuliaRegistrator (for step 2 above)
- Open an issue and add
@JuliaRegistrator registeras a comment. You can re-trigger the registrator by commenting
@JuliaRegistrator registeragain (in case registrator reports an error or to make changes).
- Add a comment to a commit and say
Note: Only collaborators on the package repository and public members on the organization the package is under are allowed to register. If you are not a collaborator, you can request a collaborator trigger registrator in a GitHub issue or a comment on a commit.
If you want to register as a private member you should host your own instance of Registrator, see the documentation.
If you have enabled TagBot on your repositories, then you may write your release notes in the same place that you trigger Registrator, or allow them to be automatically generated from closed issues and merged pull requests instead. These can later be edited via the GitHub releases interface.
To write your release notes, add a section labeled "Release notes:" or "Patch notes:" to your Registrator trigger issue/comment, after the
@JuliaRegistrator trigger. For example,
Check out my new features!
Note that if you have not enabled TagBot, no release will be made at all, and so any release notes you write will not be used.
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, or you can use TagBot as is mentioned above.
Note on documentation build
The docs for your project will be automatically built by DocumentationGenerator.jl. Please see that repo for details. Your docs should show up at pkg.julialang.org/docs.
docs/make.jl will be run to build the docs. If that is missing, the
README.md will be used instead.
Registering a package in a subdirectory
If the package you want to register is in a subdirectory of your git repository, you can tell Registrator to register it by adding the
subdir argument to your trigger, e.g.
@JuliaRegistrator register subdir=path/to/my/package.
Approving pull requests on the registry
Pull requests that comply with the automatic merging guidelines will be merged without human intervention periodically. On other cases, a registry maintainer will manually merge the pull request made by Registrator.
Private packages and registries
Private packages will be ignored by the current running instance of Registrator. Please see the documentation on how to host your own Registrator for private packages.