Collaboration via GUI Premium
Bruno offers an intuitive GUI-based Git collaboration feature, available in the Pro (opens in a new tab) and Ultimate Editions (opens in a new tab). This feature makes it easier for both engineering and non-engineering teams to collaborate seamlessly on collections.
You need to have Git installed on your machine to use these feature.
This feature includes following actions:
- Initializing Git in a Collection
- Adding and Committing Changes
- Pushing and Pulling Changes
- Branch Creation and Checkout
- Cloning a Repository
Initializing Git
Initializing Git in Bruno is the first step towards managing your API collections with version control. It’s easy and quick to set up. Follow the steps below to initialize Git.
- Launch the Bruno app.
- Navigate to the collection you want to initialize with Git.
- Click on the Git Icon in the top-right corner of the navbar.
- Click the Initialize button to set up your collection with Git.
This allows you to perform other Git operations such as adding, committing, pushing, pulling changes, and more.
Connecting to Remote Repository
Once you have initialized your collection, the next step is to connect it to a remote Git repository.
-
Create a Remote Repository on GitHub:
- Log in to your GitHub account and create a new repository.
- Note the repository URL, which will be used to link your local collection.
-
Connect Your Local Collection to the Remote Repository:
- Open a terminal and navigate to the folder where your collection is stored.
- Run the following commands to add, commit your changes, and link the local collection to the remote repository.
Add all the collection changes.
git add .
Commit all the changes you have added.
git commit -m "commit-message"
Replace
username
with your GitHub username andrepo-name
with the name of the repository you created.git remote add origin https://github.com/username/repo-name.git
Push local changes to remote repository.
git push -u origin main
After completing the above steps, your collection will be pushed to GitHub and should be visible in your repository. Once your collection is connected to the remote repository, you can manage it directly from the Bruno app.
Adding and Committing Changes
Once you’ve made changes to your collection in Bruno, you can easily commit those changes using the Git UI. This allows you to track changes and collaborate with your team efficiently.
Follow these steps to add and commit changes:
- Open the collection you've initialized with Git and access the Git UI from the main dropdown in the top-right corner.
- Go to the Changes Tab.
- Click on Add Icon for the changes you want to commit.
- Click on Commit Changes button.
- Write a Commit Message and click Commit.
You can commit all changes in a single click by pressing the Add All Changes button.
By following these steps, your changes are now committed and tracked in Git, ready to be pushed or shared with others.
Pushing and Pulling Changes
The GUI-based Git integration in Bruno allows both engineering and non-engineering teams to work together in a fast, efficient, and accurate manner. This integration ensures that your collections remain consistently up-to-date across all team members.
Before you can push or pull changes, ensure that the remote repository is linked to your project.
Pushing Changes
Push your local changes to the remote repository with just a few clicks.
- Click on main from top-right corner and select Push from drop-down.
- Confirm the Remote Server configurations.
- Click on Push button.
Now you can see all your local changes pushed to the remote repository.
Branch Creation and Checkout
With branches in Bruno, you can manage your code effectively by isolating different features or tasks.
Creating Branches
Follow the below steps to create branches in Bruno.
-
Navigate to the Collection in Bruno.
-
Click on the main from the top-right and select Create New Branch from dropdown.
-
Enter Branch Name.
-
Click on Save button.
Once the branch is created, you can start making changes to the branch.
Branch Checkout
- Click on Checkout Branch from main.
- Select the branch you want to switch from Local or Remote.
- Click on Checkout button.
- Now you're switched to your selected branch.