Skip to content
pom => github
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
README.md
claims-bitbucket.json
claims.json
licenses-by-name.json
non-standard.json

README.md

Scala Index Community Data

This repository exists to fill the gaps between the Scala Index and publicly available projects.

Claim your project

When you publish your project with a source code management tag (scm) which points to a github repository, we can fetch additional information. If you forgot to add the scm tag, edit claims.json and create a pull request to claim a project. If your project is not on the list, you will need to publish it on Maven Central or Bintray first. See publish-central to learn more about publishing.

Index artifacts which are published in java-style

When you publish your artifacts in the standard way with a Scala version number attached to the artifact name, you'll be fine, and your project will be indexed automatically (assuming it's linked with a GitHub repo, see above). In case you don't follow the Scala standard of publishing artifacts on maven, you can edit non-standard.json. We will look in the pom file for the version of the scala artifact. We will assume a binary compatibility with this scala version (ex: 2.11).

For example,

"io.gatling gatling-core": "pom"

If you never plan to publish your library in the standard Scala way (artifacts suffixed with _2.x), you can use a wildcard in the non-standard.json file. If there is at any point no backward compatibility, e.g., if the verison 2.* is compatible to scala 2.10 and 2.11 but version 3.* only to 2.11 and 2.12, you can't use a * as a wildcard and you will have to manually list all of your artifacts.

When you provide this list, your artifact will also show up as a scala artifact in the index upon the next re-index.

We also index java project significant for the scala community.

For example,

"com.typesafe config": "java"

Disambiguate Licenses

In sbt, the licenses setting is defined as: val licenses = SettingKey[Seq[(String, URL)]]. We observe that users will publish a semantically identical license under different name/URL. See https://github.com/sbt/sbt/issues/1937 for more detail

We disambiguate license by name.

You can’t perform that action at this time.