Getting started
Introduction⚓︎
Sonatype OSSRH (OSS Repository Hosting) uses Sonatype Nexus Repository Manager to provide repository hosting service for open source project binaries - be sure to review the full terms of service. OSSRH uses the Maven repository format and allows you to:
- deploy development version binaries (snapshots)
- stage release binaries
- promote release binaries and sync them to the Central Repository
Once released/published, you will not be able to remove/update/modify that artifact
We provide the option to publish artifacts using the -SNAPSHOT
suffix in
cases where you need to perform testing on your publishing process, but once
it is released there is no way to change it. Please check the
Can I change (modify, delete, update) a component on Central?
FAQ for more details.
The initial setup for your OSSRH repository requires some manual steps and human review (see why), after which your deployment process is typically modified to get components into OSSRH. These are all one time steps.
After the initial setup, publishing from OSSRH to Central is a trivial action which can be done via a browser or programmatically.
Initial Setup⚓︎
Review Requirements⚓︎
There are basic metadata and content requirements for components available in Central. We recommend getting familiar with them while your repositories are being created. For details see: Central Component Requirements.
Deployment⚓︎
Most developers find it easiest to implement a deployment procedure in order to automatically meet the component requirements. Depending on your choice of tools and approach there are many different ways to do this.
See below for information about deploying with many popular tools and approaches.
Attention
There is a limit of roughly 1024MB
on any single file uploaded to
OSSRH. Your uploads will fail with a broken pipe exception when you hit
this limit. Contact us directly if you need to upload larger components.
Releasing to Central⚓︎
Your project is deployed to a private repository which is only accessible to your project members.
At this point in the process, you will need to either release the repository using the tool you used to deploy, or by logging in and following the manual release process.
Upon release your component will be published to Central. Publishing typically occurs within 30 minutes though updates to search can take up to four hours.
OSSRH Usage Notes⚓︎
Accessing Repositories⚓︎
The following repositories allow you to access your components in OSSRH directly. Users access your components directly via the Central Repository, but for committers and other collaborators on your project this list might be useful.
Repository URL for snapshot deployment and download access:
Repository URL for release deployment, no download access! :