• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Data connectivity & integrationCode RepositoriesAdminister repositoriesArtifact settings

    Artifact settings

    If you are looking to import and use Python libraries, see the section on sharing Python libraries.

    The Libraries tab contains a list of repositories that can be referenced in your code repository, which we refer to as backing repositories. This is a list of all shared code repositories in your Foundry environment, as well as external or public libraries. You can use the Libraries tab to discover and add backing repositories.

    Viewing artifact settings requires the artifacts:view-repository permission, and managing artifact settings requires the artifacts:manage-repository permission.

    artifact-settings-tab

    Add a new artifact to your Code Repository

    To add a new artifact, select Add and choose one of two types of repositories:

    1. Local repositories: These are other code repositories in your Foundry environment that were configured as a shared library.
    2. External repositories: Artifact repositories stored out of your Foundry environment. These could be external Foundry repositories or public artifact repositories that are available in your environment.

    artifact-settings-add-repository

    If the added artifact repository contains references to additional repositories, they will be added as well. The same access permissions are required for all the dependencies of the added repository.

    When adding a local repository from a different project, a project reference to that repository will be added. This requires compass:view-project-imports and compass:import-resource-to on your own code repository and compass:import-resource-from permission on the referenced shared repository.

    While it is possible to reorder and delete backing repositories, this might break builds of transforms that use packages from those repositories. Only take this action after considering the possible implications.

    Beta OSDK generator versions toggle

    When the Enable beta OSDK versions option is enabled, users can generate beta (release candidate) ontology generator versions. The toggle is off by default.

    beta-toggle

    To enable beta OSDK versions:

    1. Navigate to the Branches tab and ensure you are on the default branch.
    2. Inside the repository's functions.json file, add "allowBetaGeneratorVersions": true to the file. To discover this file, the Show hidden files toggle may have to be enabled by selecting the cogwheel at the top near the Files header.

    beta-field-functions-json

    1. Make sure to commit this change in the Source Control tab; otherwise, it will not be reflected in the settings.
    2. Navigate to the Libraries Settings enable the Beta OSDK Versions toggle.
    3. You can now discover beta generator versions in the Generator dropdown when creating a new version in the Functions Imports tab.

    beta-versions