Best practices to configure Git environment

Learn about how to set up your Git provider for an uninterrupted experience with Gitoqlok.

Regardless of the Git provider you choose, there are some of the best practices to avoid unexpected errors and ensure an uninterrupted versioning experience with Gitoqlok.

As an example, this page contains GitHub screenshots.

1️⃣ Ensure proper access to Organization Repositories

When using an organization repository for collaborative work in Git, all developers must have the appropriate access permissions. This includes:

• Read and Write Access: All team members must have read and write permissions to pull and push changes.

• Branch Creation: Developers should have the ability to create branches. This is essential for uninterrupted and conflict-free development and managing different versions of the app.

Steps:

• Navigate to the Git repository settings.

• Under the "Manage access" or "Collaborators" section, ensure that each developer is granted the necessary permissions.

Adding outside collaborator permissions to organization repository: GitHub

2️⃣ Collaborator Setup for Personal Repositories

If a personal repository is being used, adding collaborators is essential for team collaboration. This can be done as follows:

• Add Collaborators: Ensure that any additional developers are added as collaborators to the repository and granted read, write, and create branches rights.

Steps:

1. Go to the repository's main page.

2. Click on "Settings."

3. In the "Access" section, find "Collaborators."

4. Add the second developer by their username or email.

Collaborator has accepted their invite via email: GitHub

3️⃣ Consistent Git Provider Configuration in Gitoqlok

For effective collaborative work on a single Qlik Sense app, all users must have the same Git provider set up in Gitoqlok. This ensures that everyone is working in a consistent environment, preventing potential conflicts or issues with different setups.

Steps:

• Open Gitoqlok options (either from the popup or browser extensions context menu).

• Ensure that the Git provider (GitHub, Bitbucket, GitLab, etc.) is the same for all users involved in the project.

Consistent Git Provider Configuration in Gitoqlok

4️⃣ Setting Up Git Server in Gitoqlok with Appropriate API Token Scopes

When configuring the Git server in Gitoqlok, it is important to ensure that the API token used has the correct scopes. The token should have sufficient permissions to perform the necessary Git operations.

Steps:

• Open Gitoqlok options (either from the popup or browser extensions context menu) and proceed to create a new Git server.

• Generate a new API token from your Git provider following the link near the Git API token.

• Ensure that the token includes scopes for repository access (read/write), branch management, and other necessary permissions as stated by Gitoqlok.

• Copy the API token and paste it into the Gitoqlok configuration.

See how to connect Qlik Sense to Git with appropriate API token scope screenshots for each Git provider.

Grant the "repo" scope for the token: GitHub

5️⃣ Managing Bitbucket Cloud's Commit Limit

Bitbucket Cloud has a commit limit of 100MB, which can be a challenge if working with large files or numerous changes. To handle this, consider turning the limit off in BitBucket Cloud options.

Steps:

1. Proceed to the Repository settings -> Repository details and scroll down to Advanced settings.

2. Turn off the "Block pushes with files over 100MB" option.

Managing pushes over 100MB in BitBucket Cloud

---

By following these best practices, you can ensure a seamless and collaborative Git environment for Qlik Sense. Implementing these steps will facilitate a smooth and efficient workflow, allowing your team to focus on developing and versioning Qlik Sense applications seamlessly.