While this is great, the browser is not the right place to do anything beyond simple tweaks, and as a developer, we understand that you want to use the tools you are familiar with. Nuxeo Studio Designer Git access aims at solving this problem: you can clone your project, edit it locally with your favorite tools and benefit from advanced Git features, then push your changes back in Nuxeo Studio.
Studio Designer Git Access is available to any customer benefiting from the branch management feature. To activate it, request it through a support ticket by indicating:
- Who should be given access
- Which access these people should obtain (read or write)
- On which project(s)
Nuxeo Studio Designer Git access has been designed to allow for productivity while keeping reasonable restrictions for security and ease of use reasons.
- Access to Nuxeo Studio Git repositories through HTTPS protocol.
- Leverage the full power of Git locally.
- Branches can be created and pushed as long as their name starts with
feature/(similar to Studio).
- Launch git commands on your repositories, with some restrictions.
- Only Studio Designer files can be managed. Changes to the Studio Modeler side of your project will automatically be rejected as we currently have no way to ensure the validity of your configuration made through this mean.
- We don't and will never allow rewriting history to make sure you can always revert your project to a working state. Push force, for instance, will be rejected.
- Deleting Studio branches from Git is not allowed.
- Creating / Updating / Deleting tags from Git is not allowed. Releases can be created through Studio’s interface or using a REST API. This is tied to Studio managing business logic on top of this.
As a prerequisite, a Git client should be installed on your computer.
Once logged in to Nuxeo Online Services:
- Generate a personal access token in the
My Tokenstab if you don't have one yet. It will be requested as a password to clone the project.
- Visit the
- Copy the Git URL to clone your project
- On your computer, clone your project using your Git client (typically
git clone [project URL]). When prompted, use your Nuxeo Online Services username and your personal access token.
To avoid having to type your token's content repeatedly, we recommend storing it using Git's standard
.netrc file mechanism. On Linux operating systems, it is generally created under
~/.netrc. On Windows machines, you have to create a
_netrc file in
%HOME% (More information here). The file contains the following lines:
machine connect.nuxeo.com login yourNOSLoginHere password yourTokenHere
The recommended flow is the following:
- On your computer, create a branch for your changes. It has to start with
- Check out the
- Make some changes
- Commit and push your changes
feature/branch-name) or master to push your changes. Nevertheless, we recommend using a dedicated branch to have more control.
Have a look at your changes in Studio:
- Check out the
feature/your-branch-namebranch if needed
- Pull changes. Studio regularly checks for new commits to pull.
- You can follow the procedure described in the Studio configuration review how-to to integrate your changes in the master branch.