Skip to content

LinkML Registry

The LinkML Registry is an automatically generated catalog of LinkML schemas, built by using GitHub’s Search API to discover repositories that reference LinkML. It is maintained by automated scripts that continuously search for, analyze, and index LinkML-based projects.

Howto Be Added to the Registry

Because the LinkML Registry is automatically generated, there is no manual submission process, however, you can ensure your project is included by follows the guidelines below:

  • Use LinkML: Your project is in GitHub, uses linkml or one of its repos in its dependencies.
  • File content searches: The current algorithm searches for "linkml" in project-specific configuration files including:
  • pyproject.toml
  • requirements.txt
  • setup.py, setup.cfg
  • poetry.lock, Pipfile
  • README files (.md, .rst)
  • Public Repository: Ensure your repository is public and not archived and not forked from another project.

Important Note: GitHub's code search API does not index all repositories or files immediately. Some repositories, particularly newer ones or those with lower activity levels, may not have their files indexed by GitHub's search system. This means that even if your project meets all the criteria above, it may not appear in the registry due to GitHub's indexing limitations rather than issues with your project setup. If your project doesn't appear, you may need to wait for GitHub to index your files, or consider increasing repository activity through commits, stars, or community engagement.

  • Bonus Repository Metadata: Include relevant metadata in your repository:
  • A clear description of the project
  • Use of LinkML in your codebase
  • Relevant GitHub topics (e.g., linkml, schema, ontology)
  • License information

For more details on how LinkML schema projects are discovered, please see src/scripts/discover_linkml_repos.py.

Registry Sorting and Organization

  • Primary sort: By GitHub star count (descending)
  • Secondary sort: Alphabetically by repository title

Regeneration Schedule

The registry is automatically updated through GitHub Actions workflows:

  • Trigger: Push to main branch or manual dispatch
  • Frequency: Can be run on-demand via the GitHub Actions interface
  • Process:
  • Runs discovery script to update linkml_registry.yaml
  • Generates documentation from the updated registry
  • Commits changes back to the repository
  • Deploys updated documentation to GitHub Pages