Mrs. Git Helper

Streamline your GitLab workflow right inside Visual Studio Code! Mrs. Git Helper is a powerful extension designed to accelerate your development process by automating the creation of GitLab issues, branches, and merge requests. Say goodbye to context switching and manage your entire git flow from a single, convenient view.

Features

• Multi-Host & Multi-Project Management: Configure and manage projects across multiple self-hosted GitLab instances and gitlab.com.
• Centralized Settings: A dedicated settings tab to manage all your hosts and projects.
  • Securely store GitLab access tokens.
  • Configure project-specific branch names (staging, uat, production).
  • Import and Export configurations for easy backup and sharing.
• Powerful Git Flow Tab:
  • Start New Feature: A one-click action to:
    • Create a GitLab issue.
    • Automatically create development branches (single or multi-branch strategy).
    • Instantly open merge requests to staging, uat, and prod.
  • Create Merge Request: A flexible form to:
    • Fetch and select from existing issues and branches.
    • Auto-fill MR titles based on selected issues.
    • Create new branches on the fly.
• Seamless Local Integration:
  • Map your remote projects to local repository paths.
  • After creating a branch, check it out locally with a single click.
• User-Friendly Interface: Built with Ant Design for a clean, intuitive, and responsive experience.

Getting Started

1. Installation

1. Open Visual Studio Code.
2. Press Ctrl+Shift+X to open the Extensions view.
3. Search for Mrs. Git Helper.
4. Click Install.

2. Configuration

After installation, you will see a new Mrs. Git Helper icon in the Activity Bar. Click on it to open the extension's view.

Initial Setup: Your First Host

1. Navigate to the Settings tab.
2. A default Host card will be displayed. Fill in the following details:
   • GitLab Host: The URL of your GitLab instance (e.g., https://gitlab.com or https://gitlab.my-company.com).
   • GitLab Username: Your GitLab username or email.
   • GitLab Access Token: A Personal Access Token with api scope.

How to get a GitLab Access Token?

1. Go to your GitLab profile -> Edit profile -> Access Tokens.
2. Create a new token with the api scope.
3. Copy the token and paste it here. You will only see it once!

Configuring a Project

1. Inside the Host card, click + Add Project. A new project form will appear.

2. Fill in the project details:

   • Project Name: A friendly name for your project.
   • Project ID: You can find this on your GitLab project's main page.
   • Local Repository Path: (Crucial for checkout) Click the Browse button ([...]) to select the corresponding local folder on your computer.
   • Define the names of your Production, UAT, and Staging branches.

3. Click Save All Settings at the top.

How to Use

Scenario 1: Start a New Feature from a Ticket

1. Go to the Git Flow tab.
2. Under "Start New Feature":
   • Enter the Jira/Ticket Title (e.g., TICKET-123: Add login button).
   • Select one or more projects you want to work on.
   • Choose which Merge Requests you want to create automatically (to Staging, UAT, etc.).
3. Click Start New Feature.
4. The extension will perform all actions. The results, including the issue link and created branch names, will appear below.
5. Click the checkout icon (↔) next to a branch name to fetch and switch to it locally.

Scenario 2: Create a Standalone Merge Request

1. Go to the Git Flow tab.
2. Under "Create New Merge Request":
   • Select a Project. The extension will automatically fetch its issues and branches.
   • (Optional) Select an Issue. This will auto-fill the MR title and suggest a source branch name.
   • Choose a Source Branch: Select an existing branch or check "Create New Branch" to create one.
   • Choose a Target Branch: Use the "Quick Select" buttons or find a specific branch.
3. Click Create Merge Request. The MR will be created and opened in your browser.

Contributing

If you have suggestions for improvements or bug reports, please open an issue or submit a pull request on our GitHub repository.

Enjoy a smoother GitLab workflow with Mrs. Git Helper!