revup-vscode

A VS Code extension that integrates with skydio/revup to enhance your GitHub PR workflow with smart commit messages and topic management.

Installation

Since this extension is not yet published on the VS Code Marketplace (we are currently working on finding a publisher), you can install it manually:

1. Download the Extension: Go to the Releases page and download the latest .vsix file
2. Install from VSIX: In VS Code, open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P) and run the command Extensions: Install from VSIX...
3. Select the Downloaded File: Choose the .vsix file you downloaded
4. Start Using: Once the extension is installed, you can start using it immediately. If revup is not found on your system, the extension will automatically prompt you to install it

Note: I am currently working on getting this extension published to the VS Code Marketplace for easier installation. Until then, manual installation via VSIX is required.

Prerequisites

This extension requires revup to be installed on your system. Please follow the installation instructions in the revup README to set up the core tool first. If revup is not installed, the extension will try to automatically install it in your terminal.

Features

1. VSCode Commands

• Configure GitHub OAuth Token (revup.configOAuth): Set up your GitHub OAuth token for authentication
• Open Repo Configuration File (revup.openRepoConfig): Quick access to your Repo revup configuration
• Open Global Configuration File (revup.openGlobalConfig): Quick access your Global revup configuration
• Revup Upload (revup.upload): Trigger revup upload directly from VS Code
• Revup Install (revup.install): Automatically install revup.

2. Smart Commit Messages

• Automatically templates your COMMIT_EDITMSG file when creating a new commit
• Adds the current topic and relative key ready to use
• Displays all active topics in your repository for reference

3. Commit Message Auto-completion

• Intelligent auto-completion for commit messages
• Suggests topics based on your repository's active topics
• Makes it easier to maintain consistent commit message formatting

4. Quick Access Status Bar

• Convenient status bar item for quick access to revup upload
• Visual indicator for revup integration status

Requirements

1. Install revup by following the instructions at skydio/revup
2. Configure your GitHub OAuth token using the Revup: Configure Github OAuth Key command
3. Set up your preferred branch naming style using Revup: Configure Branch Naming Style

Extension Settings

This extension contributes the following settings through VS Code's settings:

• revup.revupConfiguration: Access and modify your revup configuration

Known Issues

Please report any issues on the GitHub repository.

Release Notes

0.0.4

• In the COMMITMSG the list of modified files, each file also shows the last topic where it was modified.

0.0.3

• Auto installation on activation (skips if already installed)
• Split opening of Repo config or Global config
• Coloured keywords topic, reviewers, relative, auto-added in the EDIT-COMMITMSG
• Better error logging when no repo or no remote is found.

0.0.1

• Initial release
• Basic integration with revup
• Commit message templating
• Topic-aware auto-completion
• Status bar integration

Upcoming Features

The following features are currently being worked on:

• Extended Revup Features: Additional functionality beyond the basic features:
  • (More features to be announced)