How-to Guides

There are many git clients from the base command line interface (CLI) all the way to fully graphical programs. Here are a short list of programs we recommend. Git Bash (git cli) Install git Git for Windows easy things are easy hard ...

Overview This tutorial will help you migrate your local git repo to AllSpice. Create a new repo in AllSpice Hub. AllSpice doesn't allow you to create a repo by pushing. Copy the project URL. Link your local repo to the AllSp...

If you are migrating or mirroring a repo from your personal github account, you can generate an access token and skip this tutorial. If you need to migrate a github repo owned by an organization, you must first set the organization settings befo...

There are many reasons to use branch protection, and many individual permissions that can help your team model your workflow. To access your branch settings, click on the settings tab of any repo. Here is an example branch settings tab: Ena...

Teams are one of our most important features. Teams let you configure who can and cannot read/write files, push/pull to the repository, whether the team is paid or not, and more. TLDR, we have a short guide to change the number of paid commit...

1. Go to your Dashboard on the top left of the screen 2. Select Organization 3. Under My Organizations, select the one you wish to add people to 4. When adding collaborators to your organization, we recommend creating a new team so you can...

This article has been replaced by this article " How to invite or add people to your organizations teams " https://allspice.document360.io/docs/en/how-to-invite-or-add-people-to-your-organizations-teams

Overview Repository templates are pre-configured settings and information you can use to pre-populate new repositories. They help you standardize documentation across teams, avoid human error, and streamline workflows. Steps to create a rep...

Overview Design review or issue templates are pre-filled frameworks and content that you can set in advance for any future reviews. They are great to: Standardize processes across teams Give new engineers a starting point to help with their t...

To setup or update your email notification preferences, follow these steps: Go to your profile drop-down menu at the top right of the window. Select Settings Navigate to your Account information, the second tab from the left within the Settings ...

1. Create a new app in your slack dashboard (See slack webhooks for more info) and "From scratch" 2. Give the app a name, add it to your workspace, and select "Create App" 3. Select "Incoming Webhooks" 4. Toggle "Activate Incomin...

Making an organization public means that anyone can see your company profile in AllSpice's public explore page. In a public organization, when you set a repository as public anyone can view the repo content. If you do this, we strongly sugge...

Making a repository public has different implications depending on who's the repo owner. If the owner is set to your  organization , unchecking "Private" will have different behaviors depending on how organization visibility is set: Visibilit...

Overview 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. 1. Install .Net 5 Runtime for console Follow the ...

Overview Revision control is a continuous process, with every change and edit tracked, allowing you to pick and choose each of these edits to create a new change. Releases give the ability to point to a specific moment in the change history, wit...

# Tutorial: Organizing Multiple PCBAs A tutorial for how to use AllSpice Hub for organizing multiple PCBAs to answer the question “How can I best manage large complex projects with multiple PCBAs?” If you're in a hurry, we have a TLDR sho...

It happens to all of us. You sign off on a design review (pull request) and merge the changes, only to learn that not all of the correct changes were merged in. This how-to explains how to revert a design review and keep your commits so you can ad...

You can create custom labels for your repo. Click on the issues tab of your repo to see a list of Labels. You can delete the labels by clicking on the delete button for each label. If you'd like to edit a lable to change the name, descripti...

Summary We've all been there. You've made changes to your project and you're excited to put a button on it and push your commit right away. It's only later when you realize that you've been pushing to the wrong branch. You don't notice the problem...

Not every file you track changes in revision control is meaningful for review. ECAD tools often have large spaghetti project files that you definitely want to keep in revision control, but aren't easily readable or useful to review and clutter up th...

You may be interested in mirroring your repository from an external repo to an AllSpice Hub repo or the other way around, from an AllSpice Hub repo to an external repo. Either way, we'll show you how. Add push mirror from AllSpice to external host...

Comparing two different commits and reviewing the diff is relatively easy. Visit: https://hub.allspice.io/<org name>/<repo name>/compare/ref1...ref2 References can be branches, tags, SHAs, or even shortened tags. Ref1 should be the older re...

Closing issues To close the issues when the design review is complete, add them to the design review description with one of the following keywords followed by the issue number. ● close/closes/closed ● fix/fixes/fixed ● resolve/resolves/resolve...

Are you rebranding? Did you change organizations? It doesn't matter the reason, because changing your email address in AllSpice Hub is super easy. Adding a new email address in AllSpice Hub Navigate to the account tab of your settings Scro...

Sometimes it's easier to re-run the TortoiseGit's first start wizard if you are changing configurations or your configurations weren't set up correctly in the beginning. To re-run the first start wizard, open up TortoiseGit settings, navigate to t...

You can view files in "widescreen" mode in a design review by using the split view feature. After you click on the split view button, the view will expand to the width of the browser window.

AllSpice has a wonderful REST API. It's supported by the fantastic swagger api documentation system, so it's clean, easy to understand, and best of all, you can run and test the API commands in a web interface. Using our API you will be able to cr...

This article will show you how to create an allspice access token. Background There are a lot of different security protocols used in AllSpice. Keys You might be using SSH or GPG encryption keys to encrypt your designs as they are pushed a...

Inviting users It's easy to add and manage new users into your organization's teams. Navigate to your organization's page. This is your page's dashboard. To navigate to the page, click on the "View YourOrgName" button. From the organizati...

If you are migrating a personal repo from GitHub to AllSpice, you will most likely need a GitHub classic personal access token. Generating token Log into github.com. Click on the icon in the upper right corner, and then click on Settin...

You can convert any comment in a design review to a new issue. Click on the elipses "..." menu in the upper-right of any comment and select "Reference in new issue" Type an issue name. You can edit the body text if you wish. Click "Create issue"...

It's easy to add new members to dedicated or self-hosted server. Note : If you have a cloud account on hub.allspice.io, you can add/adjust users in your org billing page or invite new members . If you have a self-hosted or dedicated server...

Deleting a repo is easy, although permanent. Make sure you are deleting the correct repo. Visit your repository->settings Scroll all the way to the bottom to the "Danger Zone" Click on Delete Repository. You must type the name of your repo...

Changing the privacy of your repo is easy. Be an admin of the repo Visit repo->settings If you want to make a repo private, check Settings-> Visibility [x] Make Repository Private If you want to make a repo public, uncheck Settings-> Visib...

Deleting a design review is easy. You need admin access to the repo to delete a design review. If you don't see the delete button: Ask someone in your organization's owner team to delete it for you. You can @mention them in the design r...

There are a lot of reasons to transfer ownership of a repository. Many users create their own repositories in their user accounts and would like to transfer it to an organization. Contract manufacturers might transfer ownership of a design after the...

Moving repo to AllSpice from A365 Identify repository to migrate Download the project locally using the Altium Designer interface Create new repo in your org on hub.allspice.com Set up branch protection on main Prevent pushes directl...

Background Milestones help you with project management. Any issue or design review can be linked to a milestone, allowing you to organize features and fixes based on specific goals. For instance, you might create a milestone for your next PCB ...

Background TLDR Jump to solution Merging a local dev branch directly into main without creating a pull request might not be the standard practice in team-based or open-source projects. However, there are scenar...