GRC VSCode Extension

An extension for using GRC inside Visual Studio Code. Automatically start GitHub repositories in your current workspace.

Table of Contents

• Download
• Features
  • GRC: Add Collaborator to Remote Repository
  • GRC: Authenticate
  • GRC: Create Template
  • GRC: Delete Template
  • GRC: Edit Template
  • GRC: Install GRC
  • GRC: Merge Templates
  • GRC: Start GitHub Repository Here
• Configurations
• Requirements
• Known Issues
• Release Notes
  • 0.0.1
  • 0.0.2
  • 0.0.3
  • 0.0.4

Download

You can download GRC extension here: https://marketplace.visualstudio.com/items?itemName=ArthurSudbrackIbarra.grc.

Features

Bellow, all the GRC extension features will be listed. To use commands, open the command pallete with:

• Ctrl + Shift + p
• ⌘ + Shift + p

GRC: Add Collaborator to Remote Repository

Use this command to add a collaborator to one of your remote GitHub repositories. You'll be asked to enter the repository name, the collaborator name and the permission of the collaborator.

GRC: Authenticate

Use this command to authenticate to GitHub with GRC. You must use this command before using any other commands that involve interaction with your GitHub account.

GRC: Create Template

Use this command to create a GRC template. Visual Studio Code will open a terminal instance and run the 'grc temp generate' command for you.

GRC: Delete Template

Use this command to delete a GRC template.

GRC: Edit Template

Use this command to edit a GRC template. The template YAML file will be opened in your Visual Studio Code workspace.

GRC: Install GRC

Use this command to install GRC in your machine in case you don't have it yet. You'll be asked to choose the directory where GRC will be installed.

GRC: Merge Templates

Use this command to turn N or more GRC templates into 1. Collaborators from all the chosen templates are joined, forming a single template.

GRC: Start GitHub Repository Here

Use this command to create a remote GitHub repository and then connect your current workspace to it. The extension will list your GRC templates and ask you to choose a template, as well as the repository name and the repository description.

Configurations

You can change GRC Configurations by clicking Settings -> Extensions -> GitHub Repository Creator (GRC).

• grc.showAuthenticationErrorMessages: Whether or not to show authentication error messages on startup.

• grc.showAuthenticationStatusBar: Whether or not to display the user authentication status bar item. (Reload required).

• grc.allowPre-checksOnStartup: Whether or not to allow pre-checks on startup. Extension takes longer to load but commands will take less time to execute when first used.

• grc.showCommandsBeingUsed: Whether or not to show which GRC commands are being used. Good for learning the CLI commands.

Requirements

In order to use GRC extension, you need to have GRC installed in your machine. Fortunately, You can download it through the extension with the install-grc command. You can also follow the installation guide of the official GRC repository.

Known Issues

This extension was tested on Windows 10, Ubuntu 22.04 and macOS. Therefore, the extension might have bugs or not work in other operating systems. If you find any problems, feel free to contact the publisher.

Release Notes

GRC release notes:

0.0.1

Commands added:

• Add Collaborator
• Authenticate
• Install GRC
• Start Repository commands.

0.0.2

Commands added:

• Create GRC Template

User Experience:

• Added possibility to update GRC through the extension.
• Better feedback regarding the user being authenticated or not.

Technical Changes:

• More robust validations. GRC is installed, GRC version is correct, user is authenticated, workspace is not already a git repository.

0.0.3

Configurations added:

• grc.showAuthenticationErrorMessages
• grc.showAuthenticationStatusBar
• grc.allowPre-checksOnStartup

User Experience:

• GRC installation is now done through a Visual Studio Code terminal (more feedback).

• Added status bar item that shows if the user is authenticated or not.

• Added customizable configurations to the extension.

Technical Changes:

• GRC extension is now working on Ubuntu and macOS, it was not working previously.

0.0.4

Commands added:

• Edit GRC Template
• Delete GRC Template
• Merge GRC Templates

Configurations added:

• grc.showCommandsBeingUsed

User Experience:

• Added titles instead of placeholders when user input is needed.