Securing Design Source Inside a Design Repository
- Supported Version Control
- Managing Design Repositories
- Creating a New Repository through Altium Designer
- Creating a Repository through the Altium Vault
- Connecting to an Existing Design Repository
- Editing Repository Properties
- Disconnecting from a Repository
- Using Design Repositories
- Adding a Standard Project to a Repository
- Adding a Managed Project to a Design Repository
- Opening a Standard Project from a Design Repository
- Opening a Managed Project from a Design Repository
Parent article: Board Design Release
The best way of working from a known set of source files is to store the design project in a controlled environment, such as a version control repository. This is important because the only way of ensuring the outputs come from the correct source files is to:
- Confirm that the source fileset is up-to-date.
- Take a snapshot of them.
- Generate outputs from that snapshot.
Within Altium's Design Data Management system, such a repository is referred to as a Design Repository. Owned by the design team, the Design Repository contains a high-resolution view of the history of the design process and is the primary collaboration tool used by the design team.
The Design Repository becomes the central repository from which multiple team members can check data in and out, all the while maintaining a complete revision history of all changes made to the design. A design is therefore stored as a series of versions of its constituent project and source documents, building a progressive picture of the intent of a designer over time. By using a version-controlled Design Repository, you have the integral assurance that no revision of a design is ever lost, allowing for safe collaboration on the same design between members of a team that can be geographically diverse in their locations. The very nature of the version control system provides an audit trail for the design. Full accountability arises through transparency of who changed what, in which source document, and when. The system can support multiple version-controlled Design Repositories with the link to a particular repository being established by the version control link within the project folder.
Supported Version Control
The version control software - used to implement the repositories themselves - is supported in the following ways:
- Through Altium Designer - both Subversion (SVN) and Concurrent Versions System (CVS) version control providers are supported for implementation of Design Repositories. However, Subversion is the recommended provider as it is widely and freely-available, and in true keeping to its unified nature, Altium Designer includes Subversion capabilities built-in. Version control providers are enabled and configured on the Data Management – Version Control page of the Preferences dialog (DXP » Preferences).
SVN - Subversion is enabled by default, and set to use the Subversion that is built-in to Altium Designer. You can of course use your own external Subversion installation. If you do this, you must also ensure that the paths to the SVN executables have been specified.
- Through an Altium Vault - an appropriately licensed Altium Vault installation provides localized (and centralized) version control, courtesy of its Version Control Service. Essentially an SVN server (version 1.8), this service provides version control possibilities right there where you need them, locally, without searching or paying for external SVN management software.
Managing Design Repositories
Design Repositories are managed on the Data Management – Design Repositories page of the Preferences dialog. From this page you can perform a number of actions, including:
- Creating new file-based repositories using version control available through Altium Designer (built-in or external installation).
- Connecting to existing repositories.
- Browsing repositories shared for use through the Altium Vault's local Version Control service.
- Controlling the active state of each defined repository.
For each registered, or rather connected repository, the following information is presented:
- Name – a meaningful name for the repository. This could, for example, reflect the design projects that are stored in the repository. This name is used elsewhere in the software for quick selection of a Design Repository to be used, for example when opening a project from version control.
- Activated – whether the repository is available for use by the system (enabled) or not (disabled). A newly created or connected repository will be activated by default.
- Type – the type of repository. For a repository defined through Altium Designer, this can be either
CVS. For a repository defined through the Altium Vault's local Version Control service, this is SVN.
- Repository – the URL to the root folder of the repository.
- Status – whether the connection between Altium Designer and the repository is successful () or not (). If connection is unsuccessful a comment will be displayed, indicating the problem.
Creating a New Repository through Altium Designer
Creation of new Design Repositories from within Altium Designer is performed from the Data Management – Design Repositories page of the Preferences dialog. Simply click the Create New button and choose the type of repository you wish to create – either SVN or CVS - from the associated drop-down menu. The applicable creation dialog will appear. For an SVN repository, this is the Create SVN Design Repository dialog. Use this to give the vault a meaningful name, specify a default checkout path, and specify the location for the repository. If a folder is specified that does not currently exist, it will be created for you.
With all settings specified as required, click OK. The repository will be created at the nominated location and a connection to that repository from Altium Designer made. An entry will appear for it in the listing of Design Repositories back on the Data Management – Design Repositories page of the Preferences dialog.
Creating a Repository through the Altium Vault
Main article: Altium Vault - Local Version Control Service
Repositories can be created through the Altium Vault's local SVN server, or external repositories can be connected to. Together, all repositories are centrally managed through the VCS page of the vault's browser-based interface.
To add a Design Repository, simply click the Add Repository button, located at the top-right of the VCS page. The Repository Properties window will appear, use this to define the repository. The properties required depend on whether you are creating a new repository using the local VCS service, or linking to an existing, external repository:
- New - simply give the repository a name and a description.
- Existing - in addition to a name and description, you need to supply the URL to the repository, and your credentials (User Name, Password) to access that repository.
Design Repositories defined through the Altium Vault are populated to the client automatically during login, so users do not have to worry about urls, protocols, password etc. A repository is simply configured once, on the server, and shared with the intended users as required.
Connecting to an Existing Design Repository
In a collaborative environment, one or more Design Repositories may already have been created in a location accessible by multiple users. In this case, you do not need to create a new repository – re-inventing the wheel as it were – rather you simply need to connect to the required existing repository. This is also the case if you have removed a repository from your list of repositories, and want to add it back in again.
To connect to an existing repository, simply click on the Connect To button and choose the type of repository you wish to connect to – either SVN or CVS. The applicable connection dialog will appear. For an SVN repository, this is the SVN Design Repository dialog. Simply enter a name by which to refer to the repository from within Altium Designer, specify a default checkout path, and specify the repository access method and path to the root folder of the repository. You can also specify a particular sub-folder within the repository.
With all settings specified as required, click OK – a connection will be made and the repository will be ready for use.
Editing Repository Properties
You can also edit the properties of a Design Repository at any time. For example, you might want to change the name of the repository, as displayed and referenced within Altium Designer. Or you might want to edit the connection, perhaps to link to a different repository. To do this, simply select the entry for the repository in the listing of repositories, then click on the Properties button. The applicable Design Repository dialog will appear, from where you can make changes as required.
Disconnecting from a Repository
To disconnect from a Design Repository, simply select its entry in the list and click the Remove button. The repository is removed from the list of connected Design Repositories. The repository itself – the SVN or CVS repository – is not deleted, it simply becomes disconnected from the system. To use a repository again, simply connect to it.
Using Design Repositories
Once defined, the connected nature of a VCS-based Design Repository simplifies the ability to either add a project to that repository, or open an existing project from that repository. Instead of having to remember the path or drill down in a browse menu to select the repository, you simply choose the required repository from a convenient listing of all Design Repositories you are currently connected to, and that are activated for use.
Adding a Standard Project to a Repository
Adding a standard design project to a Design Repository is a straightforward process. With the project open, use the Add Project Folder To Version Control command from either the Projects panel or Storage Manager panel. The Add to Version Control dialog will appear. The field at the top of this dialog presents a drop-down listing of all connected and activated Design Repositories. Select the repository required.
The folder hierarchy within the chosen Design Repository is presented to you in the Folders region of the dialog. Either specify an existing folder into which to add the design files, or create a new folder using the New Folder button. In the latter case, a folder will be added at the specified position within the repository's folder hierarchy, named after the source folder containing the project.
Adding a Managed Project to a Design Repository
Main article: Altium Vault - Managed Projects
Whether creating a new managed project, or converting an existing standard design project to a managed project, the resulting project is stored in a Design Repository. As part of the respective interface used to create/convert, the repository can quickly be selected from a list of defined repositories.
Opening a Standard Project from a Design Repository
Equally straightforward is the ability to open a standard design project that resides in a Design Repository. Simply use the File » Checkout command – the Check Out dialog will appear. Use the Check out from field to choose the required repository from a drop-down listing of all connected and activated Design Repositories.
The folder hierarchy within the chosen Design Repository is presented to you in the Folders region of the dialog. Use this region to specify the exact folder that is to be checked out from the repository.
Use the Check out to field to specify where the nominated folder content is to be checked out to. This is your local sandbox area for example.
Opening a Managed Project from a Design Repository
To work on a managed project - essentially checking out as a local working copy - use the File » Open Managed Project command. The Open Managed Project dialog will appear, from where you can choose which managed project to open. Only those Managed Projects that have been shared with you (you have permission to access) will be listed. The dialog operates in two modes - Simple and Advanced. Click the button at the bottom-left to switch between these two modes accordingly.
- Simple Mode - requires the user to simply choose the required project.
- Advanced Mode - the user can switch source Managed Design Repository, if multiple repositories are available to them. They can also change where the local working copy is checked out to.