Create a new repository
    • PDF

    Create a new repository

    • PDF

    Article summary

    The first thing you'll need to do to get your electronics design project in AllSpice Hub is create a new repository. In general, each design (PCBA) should have its own repository.


    Step-by-step guide

    0. Open a new repository

    To get started, navigate to your dashboard and select New Repository in the top right. This will open a new page where you'll be able to configure your new repository.

    Dashboard page, plus sign on the right drop-down menu is open and "new repository" is highlighted.

    1. Set the owner

    If you are part of an organization you should make the organization the owner so that teams will have appropriate access to the new repository. Set yourself as the owner only if you do not intend to share with your team initially. This setting can be changed in repo settings later.

    New repository owner being selected.

    2. Repository name

    Name your repository using only alphanumeric, dash ('-'), underscore ('_') and dot ('.') characters.

    Field for repository name.

    3. Visibility

    By default you should set visibility as private. This will allow only teams and organization members access to the new repository if they have been granted permissions in the organizations settings. Members can also be granted direct access in repository settings after the repository is created.

    Visibility section, a checkbox to make repository private or not.

    If the owner in step 1 above is set to your organization, unchecking "Private" will have different behaviors depending on how organization visibility is set:

    • Visibility Private (default): All users in an organization can view the repository content.
    • Visibility Limited: Anyone with an AllSpice login can view the repository content.
    • Visibility Public: Anyone can view the repository content.

    If the owner above is set to your username, unchecking "Private" will allow anyone to view the repository content. If you do this, we strongly suggest adding an open-source license below.

    4. Template

    If you or your organization have any repository templates you can select one here to automatically populate the initial settings and content in the repository.

    To create a new template for your organization, follow our How to create a repo template guide.

    If you select a template here you can skip to step 12 of this tutorial.

    5. Issue Labels

    Here you can select an initial set of labels you can later apply to issues you create. You can select the default group, which is a pre-created set of hardware labels. These can be further configured in organization settings.

    Initial set of issue labels with a default option.

    6. Gitignore

    A .gitignore file will tell Git what files and folders it can ignore in a directory. If you are using Altium, type and select Altium from the list to use AllSpice's pre-populated .gitignore. This .gitignore prevents file types that don't need to be revision-controlled, like previews, temporaries, or assembly exports, from bloating your repository. You can view and edit this later after you have created the repository.

    If you will be adding C-code or other firmware to this repository, you can add those as well.

    .gitignore file with Altium design format selected.

    27 lines of C-code.

    7-10. License, README, Default Branch, and Signature Trust Model

    Unless you are an advanced user, the following setting can be left at default. You can find more information on these settings in the description.

    11. Template

    Only check "template" if you intend to use this repository only as a template to create new repositories from. Visit our guide on how to create repo templates to learn more.

    Template selection, checkbox to make repository a template or not.

    12. Create

    After reviewing all your new repository configurations, click the green Create Repository button at the end. This will take you to your new repo's file page, where you can see an overview. From there, you can access the settings to make any changes, or continue to clone it locally.

    Two buttons, "create repository" and "cancel".

    Repository Overview

    Repository overview. Upper left has a lock beside AllSpice, indicating a private repository. Directly underneath there is "1 Commit" which tells the repository history. To the right there is settings, which are the repository's settings.



    Was this article helpful?

    What's Next