Code Repositories
As of July 25, 2024, AWS has restricted new customer access to the CodeCommit service. Consequently, if CodeCommit is unsupported in an Amorphic-deployed AWS account, users will be unable to create code repositories of type CodeCommit.
A Code Repository provides an user the ability of source code management in amorphic notebooks. Git based repositories like github, gitlab, bitbucket and code commit repositories can be connected to the amorphic code repository. These code repositories can be attached to notebooks to save the work and reuse in the future.
Create Code Repository
To create a Code Repository:
- Click on
+ Create Code Repository. - Fill in the details shown in the table:
| Attribute | Description |
|---|---|
| Code Repository Name | Give your Code Repository a name. This name needs to be unique across the application. The name can be up to 63 characters |
| Code Repository Type | Select the type of the code repository, it can be code commit, gitlab. github or bitbucket |
| Description | Describe the purpose of the Code Repository and other important details. |
| Keywords | Keywords are indexed and searchable in the app to help you find things quickly. |
| Create Code Repository | User can enable this to create a new code commit repository along with the code repository in amorphic, this option is only available when the code repository type is of code commit and the code commit repository will be created in the same account in which amorphic is deployed. |
| Code Repository Url | User should provide https url of the git repository for github, bitbucket, gitlab and code commit |
| Default Code Repository Branch | User can provide the name of a particular branch of the git repository, this branch will be cloned in the notebook, when the code repository is attached to the notebook. |
| Create new credentials | User can enable this to attach the credentials to the code repository, by providing the credentials name, username and password, this will create a new corresponding parameter in amorphic parameter store with the user provided credentials. |
| Credentials Name | If user selects to create a new credential for the code repository, then the user must enter a name of the credential parameter, else user can select an already existing parameter in the amorphic parameter store. |
| Username | User must provide the username in order to connect to the git repository. |
| Password | User must provide the password/auth-token in order to connect to the git repository. |
Only a unique code repository can exist in amorphic with a particular repository url. Amorphic Code Repository does not support connecting to cross account code commit repositories. Code Repository of type code commit does not require credentials.
Edit Code Repository
To update a Code Repository, user must be a owner of the code repository, click on the edit icon from the details or the listing page. Only the credentials of the code repository can be updated. User can create new credentials parameter or attach different parameter to the code repository.
Code repository of type code commit cannot be updated.
Attach a Code Repository to a notebook instance
While creating or updating a notebook instance, users can optionally attach a Code Repository that they have access to.
Delete Code Repository
To delete a Code Repository, click on the delete icon from the details page or the listing page. If the code repository is of type code commit and a code commit repository was created along with the creation of code repository, the user can retain the code commit repository while deleting the code repository, if user does not select the option to retain the code commit repository, then the code commit repository will also be deleted along with the code repository. If there are any dependent notebooks which are using this code repository, the Code Repository cannot be deleted.