Skip to content

Repositories

A repository holds Maven artifacts and belongs to one account. This document covers creating one, its settings, and deleting it.

Create a repository

To create a repository, follow these steps:

  1. Sign in to artifex.soh.gg.
  2. Click Create repository.
  3. In the Name field, enter a name for people to read.
  4. In the URL name field, enter the slug that appears in the repository's address.
  5. Optional: In the Description field, describe what the repository holds.
  6. Under Visibility, select Private or Public.
  7. Click Create repository.

The repository's Maven URL is https://artifex.soh.gg/maven/OWNER/SLUG/, where OWNER is your handle and SLUG is the URL name.

Your repositories must have different slugs from each other. Two different accounts can use the same slug, because the owner's handle is part of the address.

FieldRules
Name1 to 80 characters
URL nameLowercase letters, digits, and single hyphens between them, up to 63 characters
DescriptionAt most 500 characters

Settings

To change a setting, follow these steps:

  1. Open the repository and go to Settings.
  2. Change the setting.
  3. Click Save changes.

Only an administrator of the repository can change settings. For more information, see Share a repository.

SettingDefaultWhat it does
VisibilityPrivatePublic lets anyone read the repository, including builds with no credentials. Private limits reading to the owner, the people it's shared with, and the tokens granted access. Deploying always needs write permission.
Allow replacing filesOffWhen off, a file that exists can't be deployed again. When on, deploying the same path replaces the file. See Immutability.
Allow deleting filesOffWhen off, DELETE from a Maven client and the delete actions in the pages are refused. When on, files and versions can be deleted.
Allow snapshotsOnWhen off, deploying a -SNAPSHOT version is refused. See Snapshots.
Index scopeDeployed filesWhich files the published Maven index describes. See The Maven index.

Rename the URL name

The URL name is the SLUG part of the repository's address. Changing it changes that address.

To change it, follow these steps:

  1. Open the repository and go to Settings.
  2. In the URL name field, enter the new name.
  3. Click Save changes.

Builds that use the old address stop finding the repository, so update every pom.xml, build.gradle.kts, and CI configuration that names it. A custom domain that points at the repository keeps working, because it doesn't carry the slug.

Delete a repository

Deleting a repository removes its artifacts, its files, and its index. This can't be undone.

Only the owner can delete a repository. An administrator who isn't the owner can't.

To delete a repository, follow these steps:

  1. Open the repository and go to Settings.
  2. In the Delete this repository section, click Delete repository.
  3. In the confirmation field, enter the repository's URL name exactly.
  4. Click Delete repository.

The following also happens:

  • Everyone the repository was shared with loses access, and every token grant is removed.
  • Custom domains connected to the repository are disconnected.
  • Repositories that used this one as an upstream keep the upstream, but it's turned off.